@@ -31,6 +31,27 @@ The program, in general, flows like this
4. A HTML page is saved to the filesystem
5. We do a bunch of copying around of static files into the compiled directory so everything lives side-by-side and can be referenced as if it has been in the same directory all along.
### About Page
The about page is created from *four* files, via a *single* YAML file, with
+```data/about_meta.yaml``` describing meta information about the other files and containing the information about the 'cards' at the top of the page,
+```data/public.md``` a Markdown file containing the information for the public,
+```data/astro.md``` a Markdown file containing the information for astronomers,
+```data/cd.md``` a Markdown file containing the information for computer scientists.
These are them compiled by ```about.py``` to a single YAML file, ```about.yaml``` which is read in by ```compiler.py``` when dealing with the templates and fed to ```templates/about.html``` as variables.
So, if you want to edit the information on the about page you only need to edit one of the four above files and re-run the compiler.
The markdown syntax is available [here](https://daringfireball.net/projects/markdown/syntax).
It should hopefully be at least somehwat familiar (it's the same one that is used on GitLab).
To add images stick the image file into ```images``` and then you can reference them by filename in the markdown file, for example:
+ I have a file called ```test.png``` that I want to display in the Public section.
+ I should place this file into ```images```, i.e. ```images/test.png```
+ I should edit ```data/public.md```, and place in ``````
+ I should now run ```python3 compiler.py``` (see the top-level information for how to compile correctly) and everything will be copied such that the images live in the same directory as the final HTML files.
