Skip to content

Latest commit

 

History

History
23 lines (20 loc) · 1.16 KB

README.md

File metadata and controls

23 lines (20 loc) · 1.16 KB

How to contribute to the docs

Prerequisites

Steps

  • To clone the github reposity right click your desktop and select "Git Bash Here"

  • From there you can execute git clone https://github.com/davidsdesignserver/docs.git

  • Close the current git bash window and open the cloned folder. It should be named "docs"

  • Right click in this folder and open git bash again.

  • Execute python -m venv venv

  • Execute source venv/scripts/activate

  • Execute pip install mkdocs-material

  • Execute mkdocs serve

  • If everything went smoothly it should say its "Serving on" something like http://127.0.0.1:5800

  • This is a local hosted verson of the website you use to have a live preview of the site while editing.

  • You can now open the "docs" folder inside of VSCode

  • Once inside you should be able to navigate to the bottom left branch icon and create a new branch to start working in.

  • Commits to branches other than main will not regenerate the site

  • Do not push to main without permission