khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #13621 from nextcloud/jtr/feat-readme-snippets

Browse Source 
feat(README): Add tip about using Documatt Snippets for learning / previewing
This commit is contained in:
Josh
2025-09-09 16:25:24 -04:00
committed by GitHub
parent 1bdc8efb86 eb2923e04d
commit 08d9719f17
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@@ -69,6 +69,12 @@ To edit a document, you can edit the .rst files on your local system, or work
directly on GitHub. The latter is only suitable for small fixes and improvements
because substantial editing efforts can better be controlled on your local PC.
.. tip::
If you're getting to know our documentation syntax, `give Documatt Snippets
<https://snippets.documatt.com/>`_ a try. This online editor is a great way
to practice with reStructuredText and Sphinx, and it provides a more accurate
preview of your work than GitHub does.
The best way is to install a complete Sphinx build environment and work on your
local PC. You will be able to make your own local builds, which is the fastest
and best way to preview for errors. Sphinx will report syntax errors, missing