diff --git a/.gitea/workflows/deploy-docs.yaml b/.gitea/workflows/deploy-docs.yaml new file mode 100644 index 0000000..1642178 --- /dev/null +++ b/.gitea/workflows/deploy-docs.yaml @@ -0,0 +1,36 @@ +name: Build and Deploy MkDocs + +on: + push: + branches: + - main + +jobs: + deploy-docs: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install MkDocs & Plugins + run: | + python -m pip install --upgrade pip + pip install mkdocs mkdocs-material + + - name: Build Static Site + run: mkdocs build + + - name: Deploy to Web Server via SSH + uses: https://git.weseng.de + with: + host: ${{ secrets.WEB_HOST }} + username: ${{ secrets.WEB_USER }} + key: ${{ secrets.WEB_KEY }} + source: "site/*" + target: "/var/www/git-pages/" + strip_components: 1 # Removes the "site/" folder layer so content dumps directly into your web root diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..000ea34 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,17 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..c97182f --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1 @@ +site_name: My Docs