Skip to content

Commit

Permalink
Move the documentation to the GitHub wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Jun 16, 2024
1 parent 03dac3b commit fd4243f
Show file tree
Hide file tree
Showing 16 changed files with 460 additions and 528 deletions.
24 changes: 0 additions & 24 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,27 +20,3 @@ jobs:
run: npm test
env:
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
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
/**/.DS_Store
/.idea/
/docs/api/
/etc/http-client.private.env.json
/lib/
/node_modules/
/npm-debug.log
/var/
/www/
/wiki/
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
A [Koa](https://koajs.com) view renderer based on the [Eta](https://eta.js.org) template engine.

## Documentation
- [User guide](https://docs.belin.io/koa-eta)
- [API reference](https://docs.belin.io/koa-eta/api)
- [User guide](https://github.com/cedx/koa-eta/wiki)
- [Examples](https://github.com/cedx/koa-eta/tree/main/example)

## Development
- [Git repository](https://github.com/cedx/koa-eta)
- [npm package](https://www.npmjs.com/package/@cedx/koa-eta)
- [Submit an issue](https://github.com/cedx/koa-eta/issues)

## License
Expand Down
Binary file removed docs/favicon.ico
Binary file not shown.
1 change: 0 additions & 1 deletion docs/favicon.svg

This file was deleted.

62 changes: 0 additions & 62 deletions docs/index.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/installation.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/styles.css

This file was deleted.

78 changes: 0 additions & 78 deletions docs/usage/html.md

This file was deleted.

82 changes: 0 additions & 82 deletions docs/usage/pdf.md

This file was deleted.

60 changes: 0 additions & 60 deletions etc/mkdocs.yaml

This file was deleted.

1 change: 0 additions & 1 deletion etc/requirements.txt

This file was deleted.

10 changes: 0 additions & 10 deletions etc/typedoc.js

This file was deleted.

Loading

0 comments on commit fd4243f

Please sign in to comment.