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

YunoHost documentation

Find a file

Memo 636351783a Update app_yourls.md		2022-05-02 12:30:29 +02:00
config	[enh] Production mode in theme	2021-09-06 10:47:58 +02:00
dev/plugins	Add a development environment for docker	2022-04-23 10:43:58 +02:00
images	Merge pull request #1981 from memo-567/patch-14	2022-05-02 12:10:41 +02:00
orphaned	Fix typos in Administration (part 1)	2021-08-11 18:31:50 +02:00
pages	Update app_yourls.md	2022-05-02 12:30:29 +02:00
tests	Add shebang to dead_links. Proper loop on command stdout.	2021-02-15 11:38:13 +01:00
themes	add: use submodule to provide learn4 theme	2022-04-23 12:00:41 +02:00
.gitignore	add: use submodule to provide learn4 theme	2022-04-23 12:00:41 +02:00
.gitmodules	add: use submodule to provide learn4 theme	2022-04-23 12:00:41 +02:00
.travis.yml	Fix travis idk ?	2021-02-13 23:05:09 +01:00
docker-compose.yml	Add a development environment for docker	2022-04-23 10:43:58 +02:00
Dockerfile	Add a development environment for docker	2022-04-23 10:43:58 +02:00
README.md	chg: README add how to clone also the submodule	2022-04-23 12:05:04 +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