Skip to content

Commit

Permalink
Merge pull request #950 from gardenenigma/main
Browse files Browse the repository at this point in the history
.github/workflows/docs-ci.yml added, mkdocs.yml added
  • Loading branch information
GlenWeyl authored Jun 12, 2024
2 parents d8e7af9 + b7ee61a commit adb98b8
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: docs continuous integration
on:
push:
branches:
- main
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- run: pip install mkdocs-material
- run: mkdocs gh-deploy --force
45 changes: 45 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
site_name: Plurality Docs
docs_dir: docs

theme:
name: material
palette:
primary: black
logo: assets/plurality logo.png
favicon: assets/favicon.png

markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
- toc:
toc_depth: 2

nav:
- Start here:
- Welcome: index.md
- About the book: home/About the Plurality book.md
- About the project: home/About the Plurality project.md
- Get involved: home/Get involved.md

- Contributing to the project:
- Introduction: contributing/Getting started.md
- Beginners contribution guide: contributing/Beginners contribution guide.md
- Content and edits: contributing/Contributing content and edits.md
- Translations: contributing/Contributing translations.md
- Figures and images: contributing/Contributing figures.md
- Citations and references: contributing/Contributing citations.md
- Contributing in other ways: contributing/Contributing in other ways.md
- Contributing to the docs: contributing/Contributing to the docs.md
- Pull Requests: contributing/Pull requests.md

- Book style guide:
- Book structure: style guide/Book structure.md
- Punctuation and grammar: style guide/Punctuation and grammar.md
- Figures: style guide/Images and figures.md
- Citations and referencing: style guide/Citations and referencing.md

- Governance of the project:
- Introduction: governance/Governance introduction.md
- Plural Credits: governance/Plural credits.md
- Gov4Git: governance/Gov4Git.md
- Plural Management Protocol: governance/Plural management protocol.md

0 comments on commit adb98b8

Please sign in to comment.