This code in this repository is licensed under Apache 2.0.
The content in this repository is licensed under CC BY 2.0
mkdocsmkdocs turns markdown content inside the docs/ directory into HTML+CSS+JS needed for a website.
The mkdocs.yml file in the root of the repository
configures website settings and available plugins for this build process.
The docs/requirements.txt file lists the
python dependencies necessary to build the documentation using mkdocs.
A GitHub Action called mhausenblas/mkdocs-deploy-gh-pages enables automated
building of new documentation content using mkdocs, whenever the content changes. Our workflow is defined in the
.github/workflows/mkdocs.yml file.
The action uses the docs/requirements.txt file to install the necessary dependencies for building the docs site.
After running mkdocs, the action redeploys the documentation site by force-pushing to the gh-pages branch.
GitHub Pages serves the website from the gh-pages branch of this repository.
Cal-ITP has an Organization site repository at https://github.com/cal-itp/cal-itp.github.io. This repository contains the
root website and is served (via a CNAME) from
https://docs.calitp.org.
GitHub Pages for Organizations functions such that any repository created in the Cal-ITP Organization, with
GitHub Pages enabled, will have an automatic domain at https://docs.calitp.org/repository-name.