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:12:26 +00:00
parent dfd43c6f2f
commit aa91f5e64c
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -11,13 +11,16 @@ Our website (the published version of the web site is here: https://syllabus.pir
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. 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.
2. To **add** a new *Markdown file* under the current section (**topic** or **session**) one should use the button/link **current_folder/add_new** (where **current_folder** stands for just **/** if on the home page or either 📁 **topic** or 📁 **session** depending on the current URL one is visiting at that moment. ) 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:
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.) ![](static/images/topic_header.png)
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"** (*mind the quotes*) 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"]** (*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. 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. 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.
#### 2. One could also edit the web site by using directly this Gitea instance (https://git.memoryoftheworld.org/PirateCare/Syllabus) where you just read this **README.md** file. #### 2. One could also edit the web site by using directly this Gitea instance (https://git.memoryoftheworld.org/PirateCare/Syllabus) where you just read this **README.md** file.