YunoHost documentation
Find a file
2024-05-06 21:31:57 +02:00
.github quite le french honhon 2024-03-01 05:33:07 +01:00
config Fix edition link 2023-09-14 13:42:28 +02:00
images Add general help page 2023-10-03 23:12:31 +02:00
markdownlint-rules-grav-pages Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00
orphaned Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00
pages missing language before a code block 2024-05-06 21:31:57 +02:00
tests Add shebang to dead_links. Proper loop on command stdout. 2021-02-15 11:38:13 +01:00
themes add TOS link in the footer 2024-03-11 17:16:31 +01:00
.gitignore Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00
.gitmodules add: use submodule to provide learn4 theme 2022-08-04 19:50:46 +02:00
.markdownlint.json Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00
.markdownlintignore Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00
.travis.yml Fix travis idk ? 2021-02-13 23:05:09 +01:00
docker-compose.yml Merge branch 'master' into refactor-admin-guide 2022-08-04 20:41:53 +02:00
Dockerfile include learn4 in docker image 2022-08-04 19:50:46 +02:00
README.md Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01:00

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