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-03-25 21:49:16 +00:00
parent f79feececb
commit c2e81bb84e
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -15,7 +15,7 @@ Our website (the published version of the web site is here: https://syllabus.pir
3. To **add** a new *Markdown file* one should use the button/link **add_new**. (If you want to add a new folder where that new *Markdown file* would sit start by typing the name of the new folder and add **/** (slash) after the name, the moment after you add **/** the input area will automatically let you continue with typing the name of the *Markdown file* to be added. Yet another thing which is easier if you just try it.)
4. 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** and then for Syllabus' home page the third line will be **has_topics:** with topics shown in sidebar menu, or for topic page the third line will be **has_sessions: first_session_name, second_session_name** etc. 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. In the case of *Markdown file* for session the top three lines will be three dashes, title, and then three dashes again. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*.
4. 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** and then for Syllabus' home page the third line will be **has_topics:** with topics shown in sidebar menu, or for topic page the third line will be **has_sessions: ["first_session_name.md", "second_session_name.md]** etc. 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. In the case of *Markdown file* for session the top three lines will be three dashes, title, and then three dashes again. None of those lines will appear at the web site. That's called **header**[^1] and it carries the metadata for that *Markdown file*.
5. 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.