mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00

YunoHost documentation

Find a file

Alexandre Aubin 1117f04e7d Merge pull request #2397 from silverhook/patch-2 Fix typo in buster_bullseye_migration.md		2024-02-11 17:28:03 +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
orphaned	Fix typos in Administration (part 1)	2021-08-11 18:31:50 +02:00
pages	Merge pull request #2397 from silverhook/patch-2	2024-02-11 17:28:03 +01:00
tests	Add shebang to dead_links. Proper loop on command stdout.	2021-02-15 11:38:13 +01:00
themes	[fix] test of auto api doc	2022-08-06 14:29:27 +02:00
.gitignore	add: use submodule to provide learn4 theme	2022-08-04 19:50:46 +02:00
.gitmodules	add: use submodule to provide learn4 theme	2022-08-04 19:50:46 +02: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	Fix typos	2022-10-17 23:11:40 +02:00

YunoHost Documentation

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

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