From c2e81bb84e030cc50a11c5e2cdbca36c960825da Mon Sep 17 00:00:00 2001 From: Marcell Mars Date: Wed, 25 Mar 2020 21:49:16 +0000 Subject: [PATCH] Update 'README.md' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d647101..e87a0d6 100644 --- a/README.md +++ b/README.md @@ -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.