Skip to content

Commit

Permalink
Merge branch 'docs'
Browse files Browse the repository at this point in the history
  • Loading branch information
atirut-w committed Jul 7, 2024
2 parents 8fda9d3 + 8f166b7 commit 23c8bcb
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/calling-convention.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -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!
22 changes: 22 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 23c8bcb

Please sign in to comment.