This page contains information for potential contributors to the Principia Wiki.
The content for the Principia Wiki, including pages and images, is now version controlled and managed in a Git repository available on Github. The reason for this is to simplify maintenance of the wiki and to make the wiki content more readily accessible.
If you are familiar with Git and contemporary Git forges like Github then contributing to the wiki is like any other Github repository - fork it, commit changes and then open a pull request.
If you are unfamiliar with Git or only need to make minor changes then you can use the Edit link in the bottom right corner of every wiki page, which will take you to Github's web interface. It will instruct you to fork the repository, then give you the ability to edit the page's source contents. Once done, commit the changes and Github will point you towards opening a pull request for the changes, at which point a wiki maintainer can review your changes and merge it if it all sounds reasonable.
If you would like to suggest or discuss any changes or additions to the wiki, feel free to drop by the #wiki channel on Discord or open an issue on GitHub.
The wiki uses regular Markdown syntax but with some extensions. There is a lot of documentation about Markdown on the Internet, for the basics see this Markdown Cheat Sheet for example. In addition to this there are some custom extensions to the syntax.
When writing text, split them up into reasonably sized paragraph to improve readability. If something can be a table or a list instead of a paragraph of text, make it so, as it will make the page more aesthetically pleasing. You should not hard wrap the source text, use the soft wrap option in your text editor. Hashtag-headings should be used, newline above heading but not below, and no 1st level heading should be used, as the wiki software puts one automatically.
HTML is allowed if absolutely necessary and Markdown isn't enough. If it's something that may be reused (e.g. some kind of information box), it should become a template.
To link to internal pages in the wiki, there are [[wikitext-like]] links, like such: Viking Helmet. You should use these over regular Markdown links for internal pages, as it allows the wiki software to create relationships between pages and e.g. figure out which pages are wanted or orphaned.
For larger pages with lots of headers, it is useful to have a table of contents at the top of the page, below the first block of text. A table of contents can be inserted into a page with [toc].
The wiki has a template system for reusable components such as infoboxes. They take a JSON string which is passed onto a Twig template. These templates can be found in wiki/templates/functions/ in the principia-web codebase.
Titles are taken from the file name. Usually page titles should be Title Cased Whenever Possible, but "small" words like prepositions should not be capitalised. We do not follow any particular handbook in terms of what constitutes as one, but use your best judgement.
Underscores in the file name is converted into spaces for the human readable name, e.g. Creating_a_Bee_Smasher_Minigame.md becomes Creating a Bee Smasher Minigame. In order to represent slashes in the file name while keeping all files in the same directory, the letter "Ä" is used as a replacement for a slash. For example, LuaScriptÄthis.md becomes LuaScript/this. This is subject to change.
