Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/YunoHost/doc
YunoHost documentation
https://github.com/YunoHost/doc
closember documentation yunohost yunohost-documentation
Last synced: 8 days ago
JSON representation
YunoHost documentation
- Host: GitHub
- URL: https://github.com/YunoHost/doc
- Owner: YunoHost
- Created: 2013-11-15T19:58:06.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T22:18:58.000Z (7 months ago)
- Last Synced: 2024-04-14T00:43:08.319Z (7 months ago)
- Topics: closember, documentation, yunohost, yunohost-documentation
- Language: SCSS
- Homepage: https://yunohost.org
- Size: 52.5 MB
- Stars: 144
- Watchers: 38
- Forks: 485
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-starred - YunoHost/doc - YunoHost documentation (documentation)
README
# YunoHost Documentation
- [Web Site](https://yunohost.org)
- Based on [Grav](https://getgrav.org/)Please report [issues on YunoHost bugtracker](https://github.com/YunoHost/issues/issues).
## Note on package documentation
Package documentation should be done in the package repository itself, under the `/doc` folder.
You can learn about it here:## Contributing
This repo use a **submodule** to provide the theme. So when you clone use:
```bash
git clone --recursive https://github.com/YunoHost/doc.git
```You can refer to the page on [writing documentation](https://yunohost.org/write_documentation).
If you know docker, you can run:
```bash
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):
```bash
./node_modules/sass/sass.js themes/yunohost-docs/scss:themes/yunohost-docs/css --style expanded
```Source: