Add docs

lulunac27a · Apr 12, 2024 · 8e04b1c · 8e04b1c
1 parent fe82fd6
commit 8e04b1c
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 0 deletions.
diff --git a/.github/workflows/docs.yml 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
diff --git a/docs/index.md 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.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,3 @@
+site_name: Dice Game in Haxe
+theme: material
+repo_url: https://github.com/lulunac27a/dice-game-haxe
Original file line number	Diff line number	Diff line change
		@@ -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.