paritybit.ca Web Site

NOTE: This README is out of date and will be updated soon.

Use of Git Logo

The Git Logo (incorporated in the logo for git.paritybit.ca by me) was created by Jason Long and is licensed under the Creative Commons Attribution 3.0 Unported License. It was retrieved from https://git-scm.com/downloads/logos.

Build Scripts

The build script compile 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 and the whole script looks quite hacky. It makes me feel warm and fuzzy.

The publishing script publish was also written in a similar way and is particularly tailored to the layout and design of my webpages.

Format of a Valid Page

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). 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 and preceded by markdown "comment markers": [//]:. If any of 1-4 are not needed, the line must still exist but, other than the markdown comment marker, the line must be blank. There shouldn't even be double quote characters on the line.

See the files in the pages/ directory for examples.

The code for this website (the JavaScript and the code in this repository) is licensed under the GNU GPLv3.0-or-later. The content of the web pages (HTML/CSS/Images/etc) is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.