mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
YunoHost documentation
9f777986ee
* Dead link vps.arn-fai.net * [fix] dead link * [fix] dead link * [fix] Dead link * [fix] Dead link |
||
|---|---|---|
| .github | ||
| config | ||
| images | ||
| markdownlint-rules-grav-pages | ||
| orphaned | ||
| pages | ||
| tests | ||
| themes | ||
| .gitignore | ||
| .gitmodules | ||
| .markdownlint.json | ||
| .markdownlintignore | ||
| .travis.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| README.md | ||
YunoHost Documentation
Please report issues on YunoHost bugtracker.
Note on package documentation
Package documentation should be done in the package repository itself, under the /doc folder.
You can learn about it here: https://yunohost.org/packaging_app_doc
Contributing
This repo use a submodule to provide the theme. So when you clone use:
git clone --recursive https://github.com/YunoHost/doc.git
You can refer to the page on writing documentation.
If you know docker, you can run:
docker-compose up
Regenerate the CSS
We use scss to manage the CSS. If you want to change it, you must rebuild it.
First install npm, then in the root folder of this repo, install sass: npm install sass
Finally you can rebuild the CSS with (You can replace expanded by compressed if you want):
./node_modules/sass/sass.js themes/yunohost-docs/scss:themes/yunohost-docs/css --style expanded
Source: https://sass-lang.com/guide