Skip to content

README.md

Latest commit

 

History

History
29 lines (18 loc) · 772 Bytes

README.md

File metadata and controls

29 lines (18 loc) · 772 Bytes

Formula Trinity Docs Starter

MkDocs + Material theme. Write pages in Markdown, preview locally, and auto-deploy to GitHub Pages.

Quick Setup

Install tooling

pip install -r requirements.txt

Run locally

mkdocs serve

Open: http://127.0.0.1:8000

Folder Structure

Each Folder has its own media folder where all the images/videos are kept.

How to update the docs

(MAKE SURE TO GIT PULL BEFORE DOING ANYTHING)

Once you make a document in any of the folders or make a new folder, make sure to reference them in the mkdocs.yml file as only then you will be able to see it locally or live through github once you push.

I would recommend to use pull requests for me to review the changes and to ensure it does not break the website.