paritybit.ca

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

commit 4c21ff0da104e5b53e91c561431548c0d0191b4d
parent 5ec285a9ca9c8c33f199b6a8477978ba26aa98f8
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Thu, 12 Sep 2019 11:04:00 -0400

Add further clarifications to readme

Diffstat:
MREADME.md | 13+++++++------
1 file changed, 7 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md @@ -1,7 +1,7 @@ # paritybit.ca Web Site -This is the server code, bare markdown files, essential public files, and build -script for the [paritybit.ca](https://www.paritybit.ca) website. +This is the bare markdown files, un-minified CSS files, essential public files, +and build script for the [paritybit.ca](https://www.paritybit.ca) website. The build script `createpages.sh` was written to serve the needs of building my webpages and was not coded to be a tool for the general public. Therefore, a lot @@ -23,10 +23,11 @@ things: table of contents (the name of a section and the name of the header it is pointing to _must_ be identical). This is a semicolon `;` separated list of header names like so: `"Introduction; Building; sub:Compiling; subsub:clang; - subsub:gcc; sub:Environment; Further Reading"` -5. The content of 2-4 must be enclosed by double-quote `"` characters. If any of - 1-4 are not needed, the line must still exist but there must be no content on - the line, not even the double-quote characters. + subsub:gcc; sub:Environment; Further Reading"`. +5. The content of 2-4 must be enclosed by double-quote `"` characters and + preceded by markdown "comment markers": `[//]:`. If any of 1-4 are not + needed, the line must still exist but there must be no content on the line, + not even the double-quote characters (markdown comment markers may be left). See the files in the `pages/` directory for examples.