From 8e04b1c3eae35856d8ad5e4a63f24d2743fa940f Mon Sep 17 00:00:00 2001 From: lulunac27a <100660343+lulunac27a@users.noreply.github.com> Date: Thu, 11 Apr 2024 21:02:37 -0500 Subject: [PATCH] Add docs --- .github/workflows/docs.yml | 28 ++++++++++++++++++++++++++++ docs/index.md | 3 +++ mkdocs.yml | 3 +++ 3 files changed, 34 insertions(+) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..45f380c --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,28 @@ +name: docs +on: + push: + branches: + - master +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Configure Git Credentials + run: | + git config user.name github-actions[bot] + git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/setup-python@v5 + with: + python-version: 3.x + - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV + - uses: actions/cache@v4 + with: + key: mkdocs-material-${{ env.cache_id }} + path: .cache + restore-keys: | + mkdocs-material- + - run: pip install mkdocs-material + - run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..5824fc8 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,3 @@ +# Dice Game in Command Line Application in Haxe + +This is a dice game app using Haxe. It uses a command line interface to enter number of dice and prints the dice output. \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ccbc993 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,3 @@ +site_name: Dice Game in Haxe +theme: material +repo_url: https://github.com/lulunac27a/dice-game-haxe \ No newline at end of file