Skip to content

Commit

Permalink
ADD: first version of mkdocs with github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
sdevenes committed May 29, 2024
1 parent 561cfda commit b6b5255
Show file tree
Hide file tree
Showing 24 changed files with 3,415 additions and 6,334 deletions.
49 changes: 49 additions & 0 deletions .github/workflows/action-mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build mkdocs material to Github Pages

# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [main, dev]
pull_request:
branches: [main, dev]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

- name: Set up Python 3.10 🐍
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Install dependencies 💻
shell: bash
run: |
sudo apt-get update
echo "Install build-essential"
sudo apt-get install -y build-essential
pip install -r requirements.txt
- name: Build mkdocs material 🔧
shell: bash
run: |
mkdocs build
ls -la
ls -la site
- name: Deploy 🚀
uses: JamesIves/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: site # The folder the action should deploy.
clean: true # Automatically remove deleted files from the deploy branch

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
site/
2 changes: 2 additions & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,3 +123,5 @@ For now it is set to **remote_exam**
- https://www.youtube.com/watch?v=8u1PVouAGnk
- adding sftp server: https://medium.com/@okHadi/setting-up-a-sftp-server-inside-an-existing-docker-container-method-1-3042871db69f
- Adding versioning in mkdocs: https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
7 changes: 0 additions & 7 deletions app/mount/html/assets/css/bootstrap-4.0.0.min.css

This file was deleted.

6 changes: 0 additions & 6 deletions app/mount/html/assets/css/bootstrap-5.3.3.min.css

This file was deleted.

7 changes: 0 additions & 7 deletions app/mount/html/assets/js/bootstrap-4.0.0.min.js

This file was deleted.

Loading

0 comments on commit b6b5255

Please sign in to comment.