wiki / help / about-this-wiki Edit this page Edited (3f3d3e2) at 2021-04-03 by Dilyn Corner ABOUT THIS WIKI ________________________________________________________________________________ This Wiki is generated from plain .txt files and supports some basic formatting options. Any formatting is simply substituted using a call to 'sed' during site generation. The custom syntax is designed to be unobtrusive as white-space controls layout. Full HTML is also supported in pages though it should only be used if 100% necessary. [0.0] Index ________________________________________________________________________________ - Repository layout [1.0] - Relative links [2.0] - Reference links [3.0] - Links to Github [4.0] - HTML [4.0] [1.0] Repository layout ________________________________________________________________________________ The Wiki lives in a separate repository ($/kiss-community/wiki). It is then imported as a submodule inside of the website's repository ($/kiss-community/website). This keeps things neat and tidy. It also makes contribution easier as it's less daunting compared to nesting it inside the website's tree. [2.0] Relative links ________________________________________________________________________________ Links to other wiki pages can be written in the following way: @/help/wiki-syntax Which is turned into: @/<a href="/wiki/help/wiki-syntax">wiki-syntax</a> [3.0] Reference links ________________________________________________________________________________ Adding  to some text will create an anchor link to a corresponding reference. This corresponding reference must also be created by the writer of the document. The build system will simply link them together for you.  The above table of contents [0.0] is simply the same concept but in reverse. This simple find/replace ends up being a very powerful tool.  Clicking the above reference will scroll the page to these anchor links.  Links such as this one must start at column zero. [4.0] Links to Github ________________________________________________________________________________ Links to GitHub repositories can be written in the following way: $/username $/username/repo $/username/repo/commits/etc Which is turned into: $/<a href="https://github.com/username">username</a> [5.0] HTML ________________________________________________________________________________ Writing HTML directly is also supported as these .txt files will be inserted into a HTML template during the build process. Usage of HTML should be avoided as it makes the plain text files themselves less readable. When writing the greater-than or less-than characters, use the HTML entities in place of the characters to prevent them being interpreted as HTML. ________________________________________________________________________________ Dylan Araps (C) 2019-2020 kiss-community (C) 2020-2021 Dilyn Corner (C) 2021 Linux(R) is the registered trademark of Linus Torvalds in the U.S. and other countries.