paritybit.ca

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

commit 1161519917bc85b57634b3787800473151088ad1
parent 0dec40e9da3f2574c8b9d53967e1cd24388619fc
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Thu, 12 Sep 2019 10:54:47 -0400

Update README.md with documentation on createpages.sh

Diffstat:
MREADME.md | 36+++++++++++++++++++++++++++++++-----
1 file changed, 31 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md @@ -1,8 +1,34 @@ # paritybit.ca Web Site -This is the server code, bare markdown files, essential public files, and build scripts -for the [paritybit.ca](https://www.paritybit.ca) website. +This is the server code, bare markdown files, essential public files, and build +script for the [paritybit.ca](https://www.paritybit.ca) website. -The code for this website is licensed under the GNU GPLv3.0-or-later whereas -the content of the actual web pages is licensed under the Creative Commons -Attribution-ShareAlike 4.0 International License. +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 +of the solutions depend on structuring a page in a specific way so that I didn't +need to bother making the solution work in general use cases. + +To build a page that is properly compiled by the script, there are 5 essential +things: + +1. The first line of the file must be the title for the page. The text here will + become the content of the HTML \<title\> tag. +2. The third line of the file must be a description of the content of the page. + This text will become the content of the HTML \<meta\> description tag. +3. The fifth line of the file must be a list of the CSS files that the HTML page + needs. This is a space-separated list of css files like so: `"base.css + extra.css test.css"`. +4. The seventh line of the file must be a list of the + sections/subsections/subsubsections which will become the content of the + table of contents (the name of a section and the name of the header it is + pointing to _must_ be identical). +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. + +See the files in the `pages/` directory for examples. + +The code for this website (Javascript and the code in this repository) is +licensed under the GNU GPLv3.0-or-later. The content of the web pages (HTML+CSS) +is licensed under the Creative Commons Attribution-ShareAlike 4.0 International +License.