From bcb71bfb644bcb77ab4151275b4881e663ceb0a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Felix=20=28xq=29=20Quei=C3=9Fner?= Date: Mon, 15 Mar 2021 19:24:34 +0100 Subject: [PATCH] Some readme. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 61d47cc..3649136 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,34 @@ # Zig Embedded Group - Website and Articles +This project both contains the contents and the generation of the ZEG website. +## Folder Structure + +``` +. +├── build.zig +├── deps Contains submodule dependencies +│ └── … +├── LICENCE +├── README.md +├── render Not included in the repo, will contain the rendered website +│ └── … +├── src Source of the website generator and other tools +│ └── main.zig +└── website Contains the raw input data for the website + ├── articles Contains all articles in the format `YYYY-MM-dd - ${TITLE}.md` + │ └── … + ├── img Contains the images used on the website. + │ └── … + ├── index.md Index page of the website + └── tutorials Contains the raw tutorial files + └── … +``` + +## Markdown + +The website uses basic markdown that allows GFM style tables and also supports *some* placeholders: + +- `` will insert a table of contents if alone in a single line. The ToC will be rendered in the same depth as the next heading, so everything higher in the hierarchy will be ignored. +- `` renders a list of all available articles +- `` renders a list of the 10 latest articles