1
0
mirror of https://github.com/avinal/avinal.github.io.git synced 2026-07-04 07:40:09 +05:30

more options added{

This commit is contained in:
avinal
2021-02-14 23:08:30 +05:30
parent b43c6e3448
commit 465e232c79
+27
View File
@@ -6,6 +6,7 @@ reStructuredText in GitHub
:slug: rst-guide :slug: rst-guide
:category: development :category: development
:tags: rst, github :tags: rst, github
:summary: reStructuredText syntax
- Headers - Headers
@@ -103,5 +104,31 @@ reStructuredText in GitHub
your html code here your html code here
</put> </put>
- Notes, warnings
.. code-block:: rst
.. note::
Put your note here.
.. warning::
Put your warning here.
.. important::
Put instructions here.
.. admonition:: custom-text
Custom description here.
These all are supported by GitHub very well. For more exhautive list specific to Sphinx see `this <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>` link. These all are supported by GitHub very well. For more exhautive list specific to Sphinx see `this <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>` link.
Tips
----
- There must be a blank line before and after any directive. Such as after title or code block, tables etc.
- The options and content of a directives must be 1 tab indented to the directives.