qa-knowledge-hub

Welcome to Knowledge Hub repository for Hepapi QA Team!

How to add a new Page

1. Create a new .md file under in the docs/ folder
2. Add the new page to the mkdocs.yml file under the nav section
   • Do not put docs/ prefix on the filepath
3. Commit and push your changes to the main branch
4. GitHub Action will automatically build and deploy the changes to the website.

About this website

Stack

Name	Description
mkDocs	Docs static site generator
Material for MkDocs	Material theme for mkDocs

Steps to run it locally

!!! Note About Static Files(images, pdfs, etc.) Put your static assets into github.com/hepapi/knowledge-hub-assets repository.

1. Make sure python3 is installed

2. Install python requirements

   pip install mkdocstrings[python]
   pip install mkdocs-material 

3. Clone the repository & cd into it

4. Run the local server

   mkdocs serve