notes on quotes and brackets...

This commit is contained in:
Marcell Mars 2020-03-25 23:08:12 +01:00
parent 0692020bcf
commit c1e22d2269
1 changed files with 2 additions and 2 deletions

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.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*.
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.
@ -27,7 +27,7 @@ Our website (the published version of the web site is here: https://syllabus.pir
2. To **edit** a particular *Markdown file* in this repository you should click on the 🖉 (pen) in the top right corner of the Gitea toolbar which appears after you open the Gitea web page of that *Markdown file*
![](static/images/edit_page.png)
- It is very important to always keep the **header**[^1] at the top of the *Markdown file*. You can recognize it as it has three dashes ( --- ) in its first line. It is then followed by **title**, the second line starting with **has_topics** (if home page) or **has_sessions:" (if topic page). The last line of the **header**[^1] should always contain only three dashes ( --- ). The header's first and last line should have only those three dashes ( --- ). The names of the topics following **has_topics:** will appear in the side bar menu. The same goes for topic page which lists its sessions in the line starting with **has_sessions:**. Here is one of the **headers** from 📁 **Syllabus/content/topic/housingstruggles.md**:
- It is very important to always keep the **header**[^1] at the top of the *Markdown file*. You can recognize it as it has three dashes ( --- ) in its first line. It is then followed by **title**, the second line starting with **has_topics** (if home page) or **has_sessions:" (if topic page). The last line of the **header**[^1] should always contain only three dashes ( --- ). So, the header's first and last line should have only those three dashes ( --- ). The names of the topics Markdown files following **has_topics:** will appear in the side bar menu. The same goes for topic page which lists its sessions Markdown files in the line starting with **has_sessions:**. The list of the names of the Markdown files looks something like this: **["first_session.md", "second_session.md"]** (Mind the brackets and the quotes.) Here is one of the **headers** from 📁 **Syllabus/content/topic/housingstruggles.md**:
![](static/images/front_matter.png)
3. To **add** a new *Markdown file* one should click the button **[New File]** in the folder where one wants the new *Markdown file* (at the moment these are 📁 **content/topic** and 📁 **content/session**)