Skip to content

Adding or Editing Projects Pages

Ryan edited this page May 11, 2018 · 2 revisions

This guide will discuss how to add new pages or edit existing pages using the DOCter jekyll theme along with our minor extension of it (located in erdl.github.io/_layouts/projects_page.html)

adding a new page with our layout

  1. Create a new file <page-name>.md in the erdl.github.io/_pages/ directory.
  2. Add content to that new file in the following format.
---
layout: projects_page
projects:
    - name: "<repo-name1>"
      repo_link: <url-to-repo1>
    .
    .
    .
    - name: "<repo-nameN>"
      repo_link: <url-to-repoN> 
---

<your content here in markdown>

  • layout tag: specifies that this page will be displayed using the projects_page layout defined in erdl.github.io/_layouts/projects_page.html
  • projects tag: specifies the list of icons that will appear with the given name that contains links to repo_link
  1. update erdl.github.io/_config.yml so that your new page can be served from our site

Edit the navigation: section of the _config.yml to include your new page in the navigation section on the left hand side of the screen. Adding a new page can be done by following this format.

# Navigation
# List links that should appear in the site sidebar here
navigation:
- text:
  url: ./
  internal: true
- text: Thermal Comfort Surveys and Models
  url: thermal_comfort_surveys_and_models
  internal: true
- text: <text-to-be-displayed-in-navigation-bar>
  url: <name-of-the-file-just-placed-in-erdl.github.io/_pages>
  internal: true 

editing an existing page with our layout

  1. Open the erdl.github.io/_pages/<page-you-want-to-edit>.md in a text editor. The page should look something like this:
---
layout: projects_page
projects:
    - name: "<repo-name1>"
      repo_link: <url-to-repo1>
    .
    .
    .
    - name: "<repo-nameN>"
      repo_link: <url-to-repoN> 
---

<your content here in markdown>

  1. Adding or removing a repo link requires that you only edit the yaml front matter such that it follows the format shown above.

  2. Editing the content of the page can be done by just editing the portion of the file that says <your content here in markdown>.

Clone this wiki locally