House Wiki

For use as a template when documentation for a house, van, etc. Out of the box features:

• Blocks search engines indexing
• Dark and light modes
• GLightbox plugin
• Search plugin

Setup

Project can be setup with Just or manually

Just

just setup

Manually

1. Create virtual environment

   python3 -m venv venv
   source venv/bin/activate
   

2. Install packages

   pip install mkdocs-material glightbox git-revision-date-localized
   

Deploy

Deployed using a Github Action to a Azure Static Web App resource

• Create a static web resource.
  • In the build details section use the following:
    • / for app location
    • site for output location
• Get Deployment Token
• Add token as a Github secret
  • The default token name is AZURE_STATIC_WEB_APPS_API_TOKEN
  • If renaming, update .github/workflows/build-and-deploy.yml

Dependencies

There is also the option to sync a Google Sheet to a csv reader via the google-sheet-to-csv node package and the MkDocs Table Reader Plugin. In order to do so:

1. follow the Google Cloud Setup instructions

2. Generate a .env file

   cp .env.sample .env
   

3. Render the table in markdown:

   <div class="sortable" markdown>
   {{ read_csv('assets/changelog.csv') }}
   </div>