YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix readme

Browse source
This commit is contained in:
OniriCorpe 2024-03-02 01:52:13 +01:00
parent 018a2b4d9f
commit c5a3e88ff7
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,20 +1,20 @@
# YunoHost Documentation # YunoHost Documentation
* [Web Site](https://yunohost.org) - [Web Site](https://yunohost.org)
* Based on [Grav](https://getgrav.org/) - Based on [Grav](https://getgrav.org/)
Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues). Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues).
## Note about package documentation ## Note on package documentation
Package documentation should be done in the package repository itself, under the `/doc` folder. 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> You can learn about it here: <https://yunohost.org/packaging_app_doc>
# Contributing ## Contributing
This repo use a **submodule** to provide the theme. So when you clone use: This repo use a **submodule** to provide the theme. So when you clone use:
```shell ```bash
git clone --recursive https://github.com/YunoHost/doc.git git clone --recursive https://github.com/YunoHost/doc.git
``` ```
@ -22,11 +22,11 @@ You can refer to the page on [writing documentation](https://yunohost.org/write_
If you know docker, you can run: If you know docker, you can run:
``` ```bash
docker-compose up docker-compose up
``` ```
## Regenerate the CSS ### Regenerate the CSS
We use scss to manage the CSS. If you want to change it, you must rebuild it. We use scss to manage the CSS. If you want to change it, you must rebuild it.