PirateCare
/
Syllabus
23
1
Fork 1
Code Issues 6 Pull Requests Releases Wiki Activity

Update 'README.md'

This commit is contained in:
Marcell Mars 2020-04-02 00:58:59 +00:00
parent 8b78edf8e9
commit fd144ef8d4
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,19 +9,17 @@ Our website (the published version of the web site is here: https://syllabus.pir
![](static/images/preview_header_small.png)
1. To **edit** the current page one should use the button/link **edit_this**. It brings you straight into the editing *Markdown file* "responsible" for that web page.
a) To **edit** the current page one should use the button/link **edit_this**. It brings you straight into the editing *Markdown file* "responsible" for that web page.
2. To **add** a new topic one should use the button/link **add_new_topic**. In the field *Name your file...* type the new topic's name (without spaces) ending with **.md**. Make sure that the first line of the *Markdown file* has only three dashes **---** followed in the second line with **title: "A Very Good Page Title"** (*mind the quotes*). The third line start with **has_sessions: ["first_session_name.md", "second_session_name.md"]** (*mind the brackets and quotes*). The sessions listed in that line will appear in a sidebar menu for that topic. In this case the forth line will be again three dashes **---** and an empty line just before the content of the page. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*. Here is the example of one of the topic's header:
b) To **add** a new topic one should use the button/link **add_new_topic**. In the field *Name your file...* type the new topic's name (without spaces) ending with **.md**. Make sure that the first line of the *Markdown file* has only three dashes **---** followed in the second line with **title: "A Very Good Page Title"** (*mind the quotes*). The third line start with **has_sessions: ["first_session_name.md", "second_session_name.md"]** (*mind the brackets and quotes*). The sessions listed in that line will appear in a sidebar menu for that topic. In this case the forth line will be again three dashes **---** and an empty line just before the content of the page. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*. Here is the example of one of the topic's header:
![](static/images/topic_header.png)
![](static/images/topic_header.png)
c) To **add** a new session one should use the button/link **add_new_session**. In the field *Name your file...* type the new session's name (without spaces) ending with **.md**. Make sure that the first line of the *Markdown file* has only three dashes **---** followed in the second line with **title: "A Very Good Page Title"** (*mind the quotes*). In this case the third line will be again three dashes **---** and an empty line just before the content of the page. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*. Here is the example of one of the session's header:
![](static/images/session_header.png)
d) After you are done with editing/adding the *Markdown files* and satisfied with the changes you should click on the button/link **publish** which would bring you straight into editing **PUBLISH.trigger.md** after which commit[^2] the web site will be published. The new changes will be visible to everyone visiting the web site.
3.To **add** a new session one should use the button/link **add_new_session**. In the field *Name your file...* type the new session's name (without spaces) ending with **.md**. Make sure that the first line of the *Markdown file* has only three dashes **---** followed in the second line with **title: "A Very Good Page Title"** (*mind the quotes*). In this case the third line will be again three dashes **---** and an empty line just before the content of the page. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*. Here is the example of one of the session's header:
![](static/images/session_header.png)
4. After you are done with editing/adding the *Markdown files* and satisfied with the changes you should click on the button/link **publish** which would bring you straight into editing **PUBLISH.trigger.md** after which commit[^2] the web site will be published. The new changes will be visible to everyone visiting the web site.
```