e5b1a364f3
* fix: edit button mkdocs * fix: edit button on mkdocs - should open edit page for dev branch and requires login if person is not already logged into github * add favicons for the mkdocs * Delete android-chrome-192x192.png * Delete android-chrome-512x512.png * Delete favicon-16x16.png * Delete favicon.ico * Delete favicon-32x32.png * Delete apple-touch-icon.png * Create temp * add favicon for mkdocs * mkdocs - highlighting for source code - Enables highlighting of source code in code blocks - allow highlighting for other languages that are not default 23 - add favicon and custom location (until folder names are changed to /docs and /doc/img * Delete temp * Add files via upload * organize mkdocs * add mkdocs extensions & plugins * remove favicon * Delete favicon.ico * Delete font-license.txt * fix mkdocs for markdown extensions fixed the name since this is not a materials theme. * add plugins to mkdocs * add mkdocs git-revision-date displays the last revision date of the current page of the documentation based on Git. this could be displayed at the bottom of each page. * add plugins for MKdocs * closes ticket https://github.com/Ralim/IronOS/issues/1649 * clean up mkdocs plugins break up code line as it's getting too long with more plugins. * fix pip install comand * fix typo --------- Co-authored-by: Ben V. Brown <5425387+Ralim@users.noreply.github.com>
41 lines
975 B
YAML
41 lines
975 B
YAML
|
|
name: Docs
|
|
|
|
# Controls when the workflow will run
|
|
on:
|
|
# Triggers the workflow on push or pull request
|
|
push:
|
|
branches: [ dev, docs ]
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
|
|
# Allow one concurrent deployment
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: true
|
|
|
|
|
|
jobs:
|
|
deploy-docs:
|
|
# The type of runner that the job will run on
|
|
runs-on: ubuntu-latest
|
|
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
- uses: actions/setup-python@v4
|
|
|
|
|
|
- run: |
|
|
pip install --upgrade pip &&
|
|
pip install mkdocs mkdocs-gen-files pymdown-extensions \
|
|
mkdocs-git-revision-date-plugin mkdocs-autolinks-plugin \
|
|
mkdocs-awesome-pages-plugin
|
|
- run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
|
|
|
|
- name: Publish docs
|
|
run: mkdocs gh-deploy
|