eduproj/material/README.md

20 lines
532 B
Markdown
Raw Normal View History

2021-08-28 08:11:51 +00:00
material
===
This directory contains the material that's used in eduproj. The documents are
all written using restructured text, chosen over markdown for its ability to
specify more structured data while still appearing readable to humans.
Recognized fields
---
General fields:
- `:title:` specifies the title that will be used when rendering it to a page.
- `:summary:` is a paragraph-long description of what the topic being discussed
is, and will be included in hover boxes or info boxes when included in other
pages.