Privacy Guides Blog
Developing
Committing to this repository requires signing your commits (git config commit.gpgsign true
) unless you are making edits via the GitHub.com text editor interface. As of August 2022 the preferred signing method is SSH commit signatures, but GPG signing is also acceptable. You should add your signing key to your GitHub profile.
This website uses mkdocs-material-insiders
which offers additional functionality over the open-source mkdocs-material
project. For obvious reasons we cannot distribute access to the insiders repository.
Team members should clone the repository with mkdocs-material-insiders
directly. This method is identical to production:
- Clone this repository and submodules:
git clone --recurse-submodules https://github.com/privacyguides/privacyguides.org.git
- Enable SSH commit verification with our local
.allowed_signers
file:git config gpg.ssh.allowedSignersFile .allowed_signers
- Install Python 3.10
- Install pipenv:
pip install pipenv
- Install dependencies:
pipenv install --dev
(install Pillow and CairoSVG as well to generate social cards) - Serve the site locally:
pipenv run mkdocs serve
- The site will be available at
http://localhost:8000
- You can build the site locally with
pipenv run mkdocs build
- This version of the site should be identical to the live, production version
- The site will be available at
If you commit to main
with commits signed with your SSH key, you should add your SSH key to .allowed_signers
in this repo.