Update 'README.md'
This commit is contained in:
parent
f04b055d43
commit
b3d8b882f4
12
README.md
12
README.md
|
@ -11,21 +11,23 @@ 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.
|
||||
|
||||
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** would expand into either 📁 **topic** or 📁 **session** depending on the current URL one is visiting at that moment)
|
||||
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. )
|
||||
|
||||
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.)
|
||||
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. 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.
|
||||
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*.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
#### 2. One could also edit the web site by using 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.
|
||||
|
||||
1. To **edit** *Markdown files* you should get inside the 📁 **content** folder where you will find two folders 📁 **topic** and 📁 **session**. All the individual *Markdown files* are saved/accessible inside those folders (you can recognize the files by their extension **.md**).
|
||||
|
||||
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** and/or **date** lines, sometimes **weights**, carrying the obvious value of the **title**, **date** or **weight** of that *Markdown file*. The **weight** value is used by the web site **menus** so the *Markdown file's* corresponding web page with a lower number will apear above the one with a higher number. Usually you make the top of the **menu** with **weight: 10** and the rest with 20, 30, 40... So if you ever go back and add a new *Markdown file* to the repository you could easily make its **weight** values somewhere in between *"the tens"* (e.g. 25, 35, 45..) without changing the **weight** value of any the *"old"* ones. Here is one of the **headers** from 📁 **content/session/badcare.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 ( --- ). 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**:
|
||||
![](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**)
|
||||
|
|
Loading…
Reference in New Issue