diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile new file mode 100644 index 0000000..6f02565 --- /dev/null +++ b/.devcontainer/Dockerfile @@ -0,0 +1,29 @@ +FROM python:3.11 + +ENV PYTHONDONTWRITEBYTECODE=1 \ + PYTHONUNBUFFERED=1 \ + USER=calitp + +RUN useradd --create-home --shell /bin/bash $USER && \ + chown -R $USER /home/$USER + +USER $USER +ENV PATH "$PATH:/home/$USER/.local/bin" +WORKDIR /app/mkdocs + +EXPOSE 8000 + +RUN python -m pip install --upgrade pip + +COPY . . + +RUN pip install -r docs/requirements.txt +RUN pip install pre-commit + +# install pre-commit environments in throwaway Git repository +# https://stackoverflow.com/a/68758943 +RUN git init . && \ + pre-commit install-hooks && \ + rm -rf .git + +CMD ["sleep", "infinity"] diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 0000000..5522bd7 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,21 @@ +// For format details, see https://aka.ms/devcontainer.json. +{ + "name": "cal-itp/mkdocs-template", + "build": { + "dockerfile": "Dockerfile", + "context": ".." + }, + "customizations": { + "vscode": { + "extensions": [ + "bpruitt-goddard.mermaid-markdown-syntax-highlighting", + "eamodio.gitlens", + "esbenp.prettier-vscode", + "mhutchie.git-graph" + ] + } + }, + "forwardPorts": [8000], + "workspaceFolder": "/app/mkdocs", + "workspaceMount": "source=${localWorkspaceFolder},target=/app/mkdocs,type=bind" +} diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..7d1fe79 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,3 @@ +.devcontainer/ +.git/ +.github/ diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..3a18c05 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,17 @@ +name: Lint and style checks + +on: + workflow_dispatch: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + lint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + - uses: pre-commit/action@v2.0.0 + - uses: gaurav-nelson/github-action-markdown-link-check@v1 diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml new file mode 100644 index 0000000..1e986e1 --- /dev/null +++ b/.github/workflows/mkdocs.yml @@ -0,0 +1,20 @@ +name: Publish docs +on: + workflow_dispatch: + push: + branches: + - main + +jobs: + mkdocs: + name: Publish docs + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + REQUIREMENTS: docs/requirements.txt + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml new file mode 100644 index 0000000..af9645a --- /dev/null +++ b/.github/workflows/setup.yml @@ -0,0 +1,35 @@ +name: New repo setup + +on: + workflow_dispatch: + push: + branches: + - main + +jobs: + precheck: + name: Pre-check + runs-on: ubuntu-latest +# if: ${{ github.repository != 'cal-itp/mkdocs-template' }} + if: always() + steps: + - name: Pre-check + run: echo "Running pre-check" + outputs: + setup_done: ${{ secrets.SETUP_DONE }} + + setup: + name: Setup + runs-on: ubuntu-latest + needs: precheck + if: ${{ !needs.precheck.outputs.setup_done }} + steps: + - name: Create repository secret + uses: gliech/create-github-secret-action@v1 + with: + name: SETUP_DONE + value: true + pa_token: ${{ secrets.PAT_REPO_SECRETS_WRITE }} + + - name: Debug message + run: echo "Running the repository setup" diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..cab082d --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,12 @@ +# includes/excludes all rules by default +default: true + +# 4-space list indentation works best with MkDocs +MD007: + indent: 4 + +# Remove line length limit - no one wants to hard wrap all their paragraphs +MD013: false + +# Allow inline HTML +MD033: false diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..5955d0d --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,15 @@ +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-added-large-files + - id: end-of-file-fixer + - id: mixed-line-ending + - id: requirements-txt-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.37.0 + hooks: + - id: markdownlint diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..14e5119 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,9 @@ +{ + "editor.defaultFormatter": "esbenp.prettier-vscode", + "editor.formatOnSave": true, + "files.encoding": "utf8", + "files.eol": "\n", + "files.insertFinalNewline": true, + "files.trimFinalNewlines": true, + "files.trimTrailingWhitespace": true +} diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..55104e9 --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,16 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "mkdocs serve", + "type": "shell", + "command": "mkdocs serve --dev-addr=0.0.0.0:8000", + "group": { + "kind": "build", + "isDefault": true + } + } + ] +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..f994297 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# mkdocs-template + +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. + +Read more about how to use this template: . + +Create a new docs site from this template: . + +## License + +This code in this repository is licensed under [Apache 2.0](./LICENSE). diff --git a/docs/.pages b/docs/.pages new file mode 100644 index 0000000..ca70080 --- /dev/null +++ b/docs/.pages @@ -0,0 +1,4 @@ +nav: + - Getting started: README.md + - Running locally: running-locally.md + - New site from template: https://github.com/cal-itp/mkdocs-template/generate diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..3f705e7 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,78 @@ +# Getting started + +This is a template repository to enable rapid creation of documentation sites built using [`mkdocs`][mkdocs] and served via +GitHub Pages under Cal-ITP's `docs.calitp.org` domain. + +## Create new site from template + +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's documentation][gh-template-repo-howto]. + +1. Head to the _generate repository_ page for this template: + + +1. Configure the new repository's details, including the **Owner** (`cal-itp`), **Name**, and **Description** + ![Screenshot showing creating a new repository from mkdocs-template](img/new-repo-init.png) + +1. Ensure the new repository's visiblity is set to **Public** + ![Screenshot showing the new repository's visibility set to Public](img/new-repo-visibility.png) + +1. Ensure the checkbox to **Include all branches** is checked + ![Screenshot showing the Include all branches checkbox checked](img/new-repo-all-branches.png) + +1. Click **Create repository from template** to finish and create the new repository + +## Finalize the new site + +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`](https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin/#customize-navigation). + +## How does this work? + +### `mkdocs` + +[`mkdocs`][mkdocs] turns markdown content inside the `docs/` directory into HTML+CSS+JS needed for a website. + +The [`mkdocs.yml`](https://github.com/cal-itp/mkdocs-template/blob/main/mkdocs.yml) file in the root of the repository +configures website settings and available plugins for this build process. + +The [`docs/requirements.txt`](https://github.com/cal-itp/mkdocs-template/blob/main/docs/requirements.txt) file lists the +python dependencies necessary to build the documentation using `mkdocs`. + +### GitHub Actions + +A [GitHub Action][gh-actions] called [`mhausenblas/mkdocs-deploy-gh-pages`][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`](https://github.com/cal-itp/mkdocs-template/blob/main/.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 + +[GitHub Pages][gh-pages] serves the website from the `gh-pages` branch of this repository. + +Cal-ITP has an Organization site repository at . This repository contains the +root website and is served (via a [`CNAME`](https://github.com/cal-itp/cal-itp.github.io/blob/main/CNAME)) from +. + +GitHub Pages for Organizations functions such that any repository created in the [Cal-ITP Organization][cal-itp-org], with +GitHub Pages enabled, will have an automatic domain at `https://docs.calitp.org/repository-name`. + +[cal-itp-org]: https://github.com/cal-itp +[gh-actions]: https://github.com/features/actions +[gh-pages]: https://pages.github.com/ +[gh-template-repo-howto]: https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template#creating-a-repository-from-a-template +[mkdocs]: https://www.mkdocs.org/ +[mkdocs-deploy-gh-pages]: https://github.com/mhausenblas/mkdocs-deploy-gh-pages diff --git a/docs/img/new-repo-all-branches.png b/docs/img/new-repo-all-branches.png new file mode 100644 index 0000000..ecc127c Binary files /dev/null and b/docs/img/new-repo-all-branches.png differ diff --git a/docs/img/new-repo-init.png b/docs/img/new-repo-init.png new file mode 100644 index 0000000..e8e730e Binary files /dev/null and b/docs/img/new-repo-init.png differ diff --git a/docs/img/new-repo-visibility.png b/docs/img/new-repo-visibility.png new file mode 100644 index 0000000..5b45958 Binary files /dev/null and b/docs/img/new-repo-visibility.png differ diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..f7699d9 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +mkdocs +mkdocs-awesome-pages-plugin +mkdocs-macros-plugin +mkdocs-material +mkdocstrings diff --git a/docs/running-locally.md b/docs/running-locally.md new file mode 100644 index 0000000..35fa36a --- /dev/null +++ b/docs/running-locally.md @@ -0,0 +1,41 @@ +# Running locally + +Requires [Docker](https://docs.docker.com/get-docker/). The following commands +should be entered and run in a terminal program like `bash`. + +## Clone the repository + +```bash +git clone https://github.com/cal-itp/mkdocs-template +cd mkdocs-template +``` + +## Build the image + +```bash +docker build -t mkdocs-template -f .devcontainer/Dockerfile . +``` + +## Run a container + +```bash +docker run -p 8000:8000 mkdocs-template +``` + +The site should be available at . + +## VS Code Devcontainer + +This repository comes with a [VS Code Devcontainers](https://code.visualstudio.com/docs/remote/containers) 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: + +```console +> Tasks: Run Build Task +``` + +To build the site and launch a local server. The site is running on at a randomly assigned port; see the +VS Code `Ports` tab for information. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ddec712 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,59 @@ +site_name: "cal-itp/mkdocs-template" +site_url: https://docs.calitp.org/mkdocs-template +repo_url: https://github.com/cal-itp/mkdocs-template +edit_uri: edit/main/docs + +theme: + name: material + features: + - navigation.tabs + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue + accent: amber + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: blue + accent: amber + toggle: + icon: material/toggle-switch + name: Switch to light mode + +extra: + analytics: + provider: google + property: G-SZB618VNBZ + +plugins: + - search + - awesome-pages + +extra_javascript: + - https://unpkg.com/mermaid@8.5.0/dist/mermaid.min.js + +extra_css: + - https://use.fontawesome.com/releases/v5.13.0/css/all.css + +markdown_extensions: + - admonition + - codehilite: + linenums: true + - pymdownx.inlinehilite + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tabbed + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_div_format + - pymdownx.smartsymbols + - meta + - toc: + # insert a blank space before the character + permalink: " ΒΆ" + - smarty diff --git a/mlc_config.json b/mlc_config.json new file mode 100644 index 0000000..7d3d9a0 --- /dev/null +++ b/mlc_config.json @@ -0,0 +1,9 @@ +// config file for markdown-link-check +// see: https://github.com/tcort/markdown-link-check +{ + "ignorePatterns": [ + { + "pattern": "localhost" + } + ] +}