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
YunoHost documentation
8088 commits 9 branches 0 tags 60 MiB
JavaScript 95.1%
SCSS 1.6%
CSS 1.5%
Twig 1.4%
Dockerfile 0.3%
Find a file
OniriCorpe 7a01793062
Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 
* Revert "Revert "markdown format""

* fix formating

* fix readme

* add .markdownlint.json

* add markdownlint-rules-grav-pages

* add markdownlint-rules-grav-pages files

* add license for Markdown Lint Rules for Grav Pages

* fix [figure] mess

* fix [figure] mess 2

* fix [figure] mess 3

* maj .gitignore

* various fixes

* fix markdownlint-rules-grav-pages

* second formater pass

* various manual fixes

* add .markdownlintignore

* markdownlintignore: auto-generated pages

* disable proper-names for html_elements

* another bunch of various markdown fixes

* Update pages/02.administer/10.install/20.dns_config/dns_config.es.md

Co-authored-by: tituspijean <titus+yunohost@pijean.ovh>

---------

Co-authored-by: Alexandre Aubin <4533074+alexAubin@users.noreply.github.com>
Co-authored-by: tituspijean <titus+yunohost@pijean.ovh>
2024-03-23 08:59:52 +01: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 Improve markdown formatting of pages, a lot of them are improperly formatted (#2429) 2024-03-23 08:59:52 +01: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

README.md

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