Guide on Editing a Team 93 Wiki

Please do not edit a Team 93 Wiki if you are not a lead, mentor, or have express permission to do so.

---

Setting up Environment

Install the programs listed below:

• Python
  • MAKE SURE TO SELECT "ADD PYTHON TO PATH"
• VS Code

Installing mkdocs and the material theme for mkdocs

    pip install mkdocs
    pip install mkdocs-material

Clone the Wiki Repo

    git clone {WIKI_LINK}

Compile the Site by running:

    mkdocs serve

If everything is setup correctly, a local website should be created here.

Writing Docs

Mkdocs is written in a language called Markdown (.md) To access a Markdown Cheat Sheet, click here.

To create a new page, create a new .md file. Then, open up mkdocs.yml and add the page to the nav section, where needed.

Adding a new page:

    nav:
        - 'New Page': new_page.md'

Adding a new page under a tab:

    nav:
        - 'Tab': 
            - 'New Page': new_page.md'

If the page is not added to the nav, it will not show up on the site.

Pushing the Docs

No special actions have to be taken when pushing the docs. Make sure to push to the main branch, and from there, Github Workflows will compile and put the website up.