From 0bca6ec137c06a187fb8c991042174a5e8962d32 Mon Sep 17 00:00:00 2001 From: Stephen Cochrane Date: Thu, 25 Mar 2021 09:35:13 +0200 Subject: [PATCH] Updated README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 8f09b30..29140f9 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,31 @@ $ make demo # Builds everything with injected warning text. $ make build ```` +### Web Pages +In the current iteration, to add a new page to the website create a `raw/.txt`, this will generate an html file placed in `site/.html`. For examples look inside `raw/`. +This file uses a custom markup called skup (skiqqy markup) that has the following features. + +#### Blocks +Wrap text/skup/html in a block, please note the `.` that terminates the title as well as the `EBLOCK` that terminates the block. +``` +SBLOCK . +<text/skup/html> +EBLOCK +``` +This will generate html that looks something like the following. +``` ++------------------------------------+ +| | +| <Title> | +| | +| <text/skup/html> | +| | ++------------------------------------+ +``` + +#### Newlines +To force a newline simply use `\\` (just like LaTeX). + ### Static Blog The goal of this website is to serve 'static' content that gets updated through scripts, this is to reduce bloat, and to ensure a fast website.