This is a template repository to enable rapid creation of documentation sites built using mkdocs and served via
+GitHub Pages under Cal-ITP’s docs.calitp.org domain.
Follow these steps to create a new repository that uses this repository as a template. Content from the new repository will be
+published online at https://docs.calitp.org/repo-name.
Once the above steps are complete and the new repository is ready, it’s a good idea to clean up the remnants of the template.
+
This includes:
+
+
Review the LICENSE file and ensure it is appropriate for your new project. If not, update it with a more appropriate
+ license before continuing.
+
Find+Replace instances of mkdocs-template with the name of your new repository.
+
Edit the docs/.pages file to update your site’s navigation menu, or delete the file to generate a navigation menu for the
+ site automatically. Read more about the
+ mkdocs-awesome-pages-plugin.
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.
Once you clone the repository locally, simply open it within VS Code, which will
+prompt you to re-open the repository within the Devcontainer.
+
Once the Devcontainer is running, bring up the Command Palette and enter:
+
> Tasks: Run Build Task
+
+
To build the site and launch a local server. The site is running on http://localhost at a randomly assigned port; see the
+VS Code Ports tab for information.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search/search_index.json b/search/search_index.json
new file mode 100644
index 0000000..2c4100b
--- /dev/null
+++ b/search/search_index.json
@@ -0,0 +1 @@
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Getting started","text":"
This is a template repository to enable rapid creation of documentation sites built using mkdocs and served via GitHub Pages under Cal-ITP\u2019s docs.calitp.org domain.
"},{"location":"#create-new-site-from-template","title":"Create new site from template","text":"
Follow these steps to create a new repository that uses this repository as a template. Content from the new repository will be published online at https://docs.calitp.org/repo-name.
Adapted from GitHub\u2019s documentation.
Head to the generate repository page for this template: https://github.com/cal-itp/mkdocs-template/generate
Configure the new repository\u2019s details, including the Owner (cal-itp), Name, and Description
Ensure the new repository\u2019s visiblity is set to Public
Ensure the checkbox to Include all branches is checked
Click Create repository from template to finish and create the new repository
"},{"location":"#finalize-the-new-site","title":"Finalize the new site","text":"
Once the above steps are complete and the new repository is ready, it\u2019s a good idea to clean up the remnants of the template.
This includes:
Review the LICENSE file and ensure it is appropriate for your new project. If not, update it with a more appropriate license before continuing.
Find+Replace instances of mkdocs-template with the name of your new repository.
Edit the docs/.pages file to update your site\u2019s navigation menu, or delete the file to generate a navigation menu for the site automatically. Read more about the mkdocs-awesome-pages-plugin.
"},{"location":"#how-does-this-work","title":"How does this work?","text":""},{"location":"#mkdocs","title":"mkdocs","text":"
mkdocs 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.
This repository comes with a VS Code Devcontainers configuration.
Once you clone the repository locally, simply open it within VS Code, which will prompt you to re-open the repository within the Devcontainer.
Once the Devcontainer is running, bring up the Command Palette and enter:
> Tasks: Run Build Task\n
To build the site and launch a local server. The site is running on http://localhost at a randomly assigned port; see the VS Code Ports tab for information.
"}]}
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
new file mode 100644
index 0000000..cb3803c
--- /dev/null
+++ b/sitemap.xml
@@ -0,0 +1,13 @@
+
+
+
+ https://docs.calitp.org/mkdocs-template/
+ 2024-06-11
+ daily
+
+
+ https://docs.calitp.org/mkdocs-template/running-locally/
+ 2024-06-11
+ daily
+
+
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
new file mode 100644
index 0000000..c25fc67
Binary files /dev/null and b/sitemap.xml.gz differ
