Skip to content

Latest commit

 

History

History
38 lines (33 loc) · 1.31 KB

README.md

File metadata and controls

38 lines (33 loc) · 1.31 KB
Raw

technical-docs

Static Badge GitHub Actions Workflow Status

Development

poetry install
poetry run pre-commit install
cp .env.example .env # edit the .env file with your own values
set -a
source .env
set +a
poetry run mkdocs serve
poetry run pre-commit run --all-files

Deployment

poetry run mkdocs gh-deploy
  • edit docs/CNAME to point to your own domain if you have one
  • github actions
    • set the GLOBAL_PASSWORD environment variable in GitHub secrets for github actions to use
    • give workflow "read & write permisions" in repository settings
  • password protection is done with mkdocs-encryptcontent plugin
    • default password is pwd
    • change the password by setting the GLOBAL_PASSWORD environment variable in GitHub secrets
  • embedded github discussions is done with gicus
    • enable discussions on the repo. install giscus app on the repo
    • create config & update overrides/partials/comments.html
    • header in markdown file used for fetching relavant discussions. like here