Creating & Editing Articles
Creating An Article
Articles on the Strata Source Wiki consist of Markdown files that work with the standard set of syntax .
The Wiki also follows some, but not all, of GitHub's Markdown styling formats (Ex. Alerts/Notices).
All the Markdown files on the Wiki are inside topics. Topics are the folders that make up certain sections of categories. Example of Category/Topic/Article: Audio/Overview/Sound System. These Markdown files are placed into where they should displayed in the Wiki.
For example, to add a article to the "Overview" topic in the "Panorama" category, all that needs to be done is to make a new Markdown file in the docs/panorama/overview folder.
For more information on the Wiki's structure, please read Wiki Structure .
Markdown file names should be named close to the title of the article as well as not containing any spaces or special characters with the exception of dashes ("-") to replace spaces.
Example: article-title-here.md.
The same should go for creating new topic folders, keep it simple and understandable.
The Wiki may not function correctly if it can't properly read the Markdown file name.
Meta Block
Every article starts with a meta block like this:
It contains metadata about the article currently being viewed, like the title to display in the sidebar, the weight used for sorting or the features flags required for this page to be considered supported.
Top Level Heading
By default no heading will be shown, even if the title property is specified. To make sure the user knows what the article is about, include a top level heading directly after the meta block like this:
While this doesn't need to be the same as the one specified in the title property, it is generally recommended for them to be same.
Writing The Article
After that follows the article content that'll get shown on the page. What is written usually doesn't follow a specific pattern.
Adding Links To Articles
If another article needs to be linked in the Wiki, the path to the article Markdown file must be used without the extension. Relative paths can also be used instead of the full file path if desired.
To add a link to other categories or topics on the Wiki, the same method is used, simply include the full or relative path.
To add a link to a specific heading inside an article, add a # followed by the header title. The best way to get the link to the needed header is to hover over the header in the Wiki itself and click the # next to it. The link will be automatically copied to the clipboard for pasting.