+ mkdocs
ci/woodpecker/push/woodpecker Pipeline failed Details

hey who said anything about grifting material design
This commit is contained in:
Kiara Grouwstra 2022-11-16 15:58:44 +01:00
parent 373648c84a
commit 455711ba4c
3 changed files with 42 additions and 0 deletions

View File

@ -34,6 +34,10 @@ The extension is licensed under [AGPL-3.0](LICENSE.txt).
* [CiviCRM Extension CLI](https://github.com/totten/civix/)
### Documentation
* [Python](https://python.org/)
## Installation (Web UI)
Learn more about installing CiviCRM extensions in the [CiviCRM Sysadmin Guide](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/).
@ -109,6 +113,14 @@ sudo cp -r ./* $FLDR
docker compose -f $CIVICRM_BIJ1_PATH/docker-compose.yml exec civi bash -c "cv ext:enable bij1migratie"
```
## Build (this) documentation
Run:
```sh
pip install mkdocs
mkdocs serve
```
## Known Issues
(* FIXME *)

1
docs/index.md Symbolic link
View File

@ -0,0 +1 @@
../README.md

29
mkdocs.yml Normal file
View File

@ -0,0 +1,29 @@
site_name: bij1migratie
repo_url: https://code.bij1.org/bij1/crm-bij1migratie
edit_uri: https://code.bij1.org/bij1/crm-bij1migratie
site_description: 'Uitleg over civicrm extensie `bij1migratie`.'
site_author: 'K Grouwstra'
theme:
name:
mkdocs
nav:
- Home: index.md
markdown_extensions:
- attr_list
- admonition
- def_list
- pymdownx.highlight:
guess_lang: False
- toc:
permalink: True
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.mark
plugins:
- search:
lang: nl