Skip to content

Commit

Permalink
Port the documentation to MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Apr 9, 2024
1 parent f3336de commit ad94d5b
Show file tree
Hide file tree
Showing 27 changed files with 163 additions and 1,697 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: continuous-integration
on: push

jobs:
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: 21
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm test
run:
needs: test
runs-on: ${{matrix.platform}}
strategy:
matrix:
platform: [macos-latest, ubuntu-latest, windows-latest]
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: 21
- 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
26 changes: 0 additions & 26 deletions .github/workflows/main.yaml

This file was deleted.

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
/**/.DS_Store
/.idea/
/bin/*.map
/docs/api/
/etc/http-client.private.env.json
/lib/
/node_modules/
/npm-debug.log
/var/
/www/
66 changes: 33 additions & 33 deletions bin/setup_hashlink.cjs

Large diffs are not rendered by default.

Empty file removed docs/.nojekyll
Empty file.
7 changes: 0 additions & 7 deletions docs/_sidebar.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/api/.nojekyll

This file was deleted.

22 changes: 0 additions & 22 deletions docs/api/assets/highlight.css

This file was deleted.

15 changes: 0 additions & 15 deletions docs/api/assets/icons.js

This file was deleted.

Loading

0 comments on commit ad94d5b

Please sign in to comment.