Getting Started With The Wiki Software

This Wiki topic assumes that you understand how to work with TypeScript, SCSS, HTML, Svelte, as well as Git submodules. The Wiki software is a submodule separate from the documentation.

If you followed the instructions from Getting Started , then the Wiki software should already be setup correctly. However, if you wish to contribute to the Wiki software, you will need to make a fork of the repository so an Pull Request can be created. From there, you must redirect the remote URL for the Wiki software submodule to use your fork so you can use your software changes with the Wiki documentation.

Editors & Extensions

The recommended editor for editing both the Wiki documentation and/or the Wiki software is Visual Studio Code . Below are a few extensions you can install to help with working the repository:

markdownlint By David Anson: A extension for Markdown linting and style checking.

Svelte for VS Code By Svelte: The official language support extension.

ESLint By Microsoft: A linter for both JavaScript and TypeScript code.

Code Spell Checker By Street Side Software: A basic spellchecker for both code and other files.

File Structure

The Wiki software file structure is much more complex than the Wiki documentation. The folder that will be worked with the most is the src folder which contains everything that drives the Wiki. Nothing else should be touched unless you know what you are doing.

lib: Where some site assets belong, where various components like buttons, Markdown notices, and more are structure, as well as where the dump parsers live.

routes: Contains the TypeScript and Svelte files used to structure and make the Wiki function. Ex. page footers, categories, CSS formatting, HTML structure, etc.

What's Next

Once you are setup and you understand what each folder in Wiki software is for, feel free to check out the other articles in the Advanced section of the Contribution topic.