diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..4e5be0a7 --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,17 @@ +name: "Deploy docs to GitHub Pages" +on: + workflow_dispatch: + push: + branches: + - main + +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v2 + - uses: atirut-w/mkdocs-deploy@master + with: + docs-dir: docs + extra-packages: mkdocs-material diff --git a/docs/calling-convention.md b/docs/calling-convention.md new file mode 100644 index 00000000..b4ee1bbb --- /dev/null +++ b/docs/calling-convention.md @@ -0,0 +1,5 @@ +# Calling Convention +!!! warning + Calling convention may change during development. This document is a work in progress. +!!! todo + TODO: Document calling convention. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..bfc65b90 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# ZDK +C compiler and libraries for Z80 development. + +!!! note + This documentation is a work in progress. If anything's missing, feel free to open an issue or a pull request. Be sure to watch out for duplicate issues and pull requests, though! diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..12d92bfd --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,22 @@ +site_name: ZDK Documentation +site_url: https://atirut-w.github.io/zdk + +repo_url: https://github.com/atirut-w/zdk/ +repo_name: atirut-w/zdk +edit_uri: edit/main/docs/ + +theme: + name: material + palette: + - media: "(prefers-color-scheme)" + - media: "(prefers-color-scheme: light)" + scheme: "default" + primary: "blue grey" + accent: "grey" + - media: "(prefers-color-scheme: dark)" + scheme: "slate" + primary: "black" + accent: "grey" + +markdown_extensions: + - admonition