Move the documentation to the GitHub wiki

cedx · Jun 16, 2024 · 7729bb0 · 7729bb0
1 parent 11583c9
commit 7729bb0
Show file tree

Hide file tree

Showing 17 changed files with 81 additions and 372 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -27,27 +27,3 @@ jobs:
     steps:
       - uses: cedx/setup-hashlink@main
       - run: hl --version
-  deploy:
-    needs: run
-    runs-on: ubuntu-latest
-    steps:
-      - name: Fetch sources
-        uses: actions/checkout@v4
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          cache: npm
-          node-version: 22
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          cache: pip
-          python-version: 3.12
-      - name: Install dependencies
-        run: |
-          npm ci
-          pip install --requirement=etc/requirements.txt
-      - name: Deploy documentation
-        run: |
-          npx gulp doc
-          mkdocs gh-deploy --config-file=etc/mkdocs.yaml --force
diff --git a/.gitignore b/.gitignore
@@ -1,9 +1,8 @@
 /**/.DS_Store
 /.idea/
-/docs/api/
 /etc/http-client.private.env.json
 /lib/
 /node_modules/
 /npm-debug.log
 /var/
-/www/
+/wiki/
diff --git a/README.md b/README.md
@@ -1,15 +1,14 @@
 # Setup HashLink VM
-![Node.js](https://badgen.net/badge/node/%3E%3D20.0.0/green) ![Action](https://badgen.net/badge/action/v4.0.1/blue) ![License](https://badgen.net/badge/license/MIT/blue)
+![Node.js](https://badgen.net/badge/node/%3E%3D20.0.0/green) ![Action](https://badgen.net/badge/action/v4.0.2/blue) ![License](https://badgen.net/badge/license/MIT/blue)
 
 Set up your [GitHub Actions](https://docs.github.com/en/actions) workflow with a specific version of the [HashLink VM](https://hashlink.haxe.org).
 
 ## Documentation
-- [User guide](https://docs.belin.io/setup-hashlink)
-- [API reference](https://docs.belin.io/setup-hashlink/api)
+- [User guide](https://github.com/cedx/setup-hashlink/wiki)
+- [Examples](https://github.com/cedx/setup-hashlink/tree/main/example)
 
 ## Development
 - [Git repository](https://github.com/cedx/setup-hashlink)
-- [GitHub marketplace](https://github.com/marketplace/actions/setup-hashlink-vm)
 - [Submit an issue](https://github.com/cedx/setup-hashlink/issues)
 
 ## License

diff --git a/bin/setup_hashlink.cjs b/bin/setup_hashlink.cjs
diff --git a/docs/favicon.ico b/docs/favicon.ico
diff --git a/docs/favicon.svg b/docs/favicon.svg
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/styles.css b/docs/styles.css
diff --git a/docs/usage/basic_setup.md b/docs/usage/basic_setup.md
diff --git a/docs/usage/inputs.md b/docs/usage/inputs.md
diff --git a/docs/usage/matrix_setup.md b/docs/usage/matrix_setup.md
diff --git a/etc/mkdocs.yaml b/etc/mkdocs.yaml
diff --git a/etc/requirements.txt b/etc/requirements.txt
diff --git a/etc/typedoc.js b/etc/typedoc.js
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,4 +1,4 @@
-import {cp, readFile, writeFile} from "node:fs/promises";
+import {readFile, writeFile} from "node:fs/promises";
 import {env} from "node:process";
 import {deleteAsync} from "del";
 import esbuild from "esbuild";
@@ -25,12 +25,6 @@ export function clean() {
 	return deleteAsync(["lib", "var/**/*", "www"]);
 }
 
-// Builds the documentation.
-export async function doc() {
-	for (const file of ["CHANGELOG.md", "LICENSE.md"]) await cp(file, `docs/${file.toLowerCase()}`);
-	return $`typedoc --options etc/typedoc.js`;
-}
-
 // Performs the static analysis of source code.
 export async function lint() {
 	await $`tsc --project tsconfig.json`;
@@ -42,12 +36,6 @@ export async function publish() {
 	for (const action of [["tag"], ["push", "origin"]]) await $`git ${action} v${pkg.version}`;
 }
 
-// Starts the development server.
-export async function serve() {
-	await doc();
-	return $({stdio: "inherit"})`mkdocs serve --config-file=etc/mkdocs.yaml`;
-}
-
 // Runs the test suite.
 export function test() {
 	env.NODE_ENV = "test";