doc/write_documentation.md

22 lines
917 B
Markdown
Raw Normal View History

2014-05-16 16:22:49 +02:00
# Write documentation
2014-05-16 16:23:19 +02:00
## Online
2014-05-16 16:22:49 +02:00
This site allows to edit content directly online.
You can edit any page by pressing `ESC` on your keyboard or by clicking the "Edit" button on the bottom-right side of your screen. You will be able to preview your changes by pressing `ESC` again or by clicking the "preview" button.
2014-05-16 16:22:49 +02:00
To create a new page, you can enter the URL and edit the page from there.
Once edited, you are able to submit your change by filling an email address.
2014-05-16 16:22:49 +02:00
2014-11-09 13:19:05 +01:00
## Via GitHub
2014-05-16 16:22:49 +02:00
The YunoHost documentation is managed through a [git repository](https://github.com/YunoHost/doc). You can send pull-requests, and do not forget to report your issues.
2014-05-16 16:22:49 +02:00
Because the online editor doesn't support uploading files, using git is the prefered way if you need to upload media (e.g. images).
2014-05-16 16:22:49 +02:00
## Syntax
2020-04-27 21:16:14 +02:00
This page uses the markdown syntax, please refer to the [documentation](doc_markdown_guide) for further information.