Move the documentation to the GitHub wiki

cedx · Jun 16, 2024 · c858779 · c858779
1 parent 3c4103a
commit c858779
Show file tree

Hide file tree

Showing 18 changed files with 5 additions and 486 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -19,27 +19,3 @@ jobs:
  env:
  AKISMET_API_KEY: ${{secrets.AKISMET_API_KEY}}
  NODE_ENV: test
- deploy:
- needs: test
- 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
@@ -4,12 +4,11 @@
 Prevent comment spam using [Akismet](https://akismet.com) service, in [JavaScript](https://developer.mozilla.org/docs/Web/JavaScript).
 
 ## Documentation
-- [User guide](https://docs.belin.io/akismet.js)
-- [API reference](https://docs.belin.io/akismet.js/api)
+- [User guide](https://github.com/cedx/akismet.js/wiki)
+- [Examples](https://github.com/cedx/akismet.js/tree/main/example)
 
 ## Development
 - [Git repository](https://github.com/cedx/akismet.js)
-- [npm package](https://www.npmjs.com/package/@cedx/akismet)
 - [Submit an issue](https://github.com/cedx/akismet.js/issues)
 
 ## License

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/installation.md b/docs/installation.md
diff --git a/docs/styles.css b/docs/styles.css
diff --git a/docs/testing.md b/docs/testing.md
diff --git a/docs/usage/check_comment.md b/docs/usage/check_comment.md
diff --git a/docs/usage/submit_ham.md b/docs/usage/submit_ham.md
diff --git a/docs/usage/submit_spam.md b/docs/usage/submit_spam.md