Skip to content

Commit eb2923e

Browse files
feat(README): Add tip about using Documatt Snippets for learning
Added a tip about using Documatt Snippets for practicing reStructuredText. Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent ece5f2c commit eb2923e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,12 @@ To edit a document, you can edit the .rst files on your local system, or work
6969
directly on GitHub. The latter is only suitable for small fixes and improvements
7070
because substantial editing efforts can better be controlled on your local PC.
7171

72+
.. tip::
73+
If you're getting to know our documentation syntax, `give Documatt Snippets
74+
<https://snippets.documatt.com/>`_ a try. This online editor is a great way
75+
to practice with reStructuredText and Sphinx, and it provides a more accurate
76+
preview of your work than GitHub does.
77+
7278
The best way is to install a complete Sphinx build environment and work on your
7379
local PC. You will be able to make your own local builds, which is the fastest
7480
and best way to preview for errors. Sphinx will report syntax errors, missing

0 commit comments

Comments
 (0)