From 75daaa484dfdbaeedded7e22f23660610a7ecf32 Mon Sep 17 00:00:00 2001 From: avinal <185067@nith.ac.in> Date: Sun, 14 Feb 2021 22:52:05 +0530 Subject: [PATCH] github rst --- content/development/rst-small-guide.rst | 107 ++++++++++++++++++++++++ 1 file changed, 107 insertions(+) create mode 100644 content/development/rst-small-guide.rst diff --git a/content/development/rst-small-guide.rst b/content/development/rst-small-guide.rst new file mode 100644 index 0000000..04e11d3 --- /dev/null +++ b/content/development/rst-small-guide.rst @@ -0,0 +1,107 @@ +************************** +reStructuredText in GitHub +************************** + +:date: 2020-14-02 22:47 +:slug: rst-guide +:category: development +:tags: rst, github + +- Headers + + .. code-block:: rst + + Top Title + ========= + + Sub Title + --------- + + Sub Sub Title + ^^^^^^^^^^^^^ + +- Images + + - Direct + + .. code-block:: rst + + .. figure:: image-path-or-url + :align: center + :target: link-to-go-when-image-is-clicked + :alt: alternative-text-if-any + + - Indirect + + .. code-block:: rst + + .. |substitution| image:: image-path-or-url + :target: link-to-go-when-image-is-clicked + + You can use :code:`|substitution|` where you want to put your image. + +- Links + + .. code-block:: rst + + `Link Text `__ + +- Lists + + .. code-block:: rst + + - item 1 + - item 2 + + * item 1 + * itme 2 + + #. item 1 + #. item 2 + + 1. item 1 + 2. item 2 + + First two lists are unordered next two are ordered. + +- Code + + - Inline + + .. code-block:: rst + + :code:`your-code` + + - Code block + + .. code-block:: rst + + .. code-block:: language(optional) + + Your code + in multiple lines. You may enable line numbers too. + +- Tables + + .. code-block:: rst + + +----------------+----------------+ + | Header Cell | Header Cell | + +================+================+ + | Data cell | Data Cell | + +----------------+----------------+ + | Header Cell | Header Cell | + +----------------+----------------+ + +- Raw HTML block + + .. code-block:: rst + + .. raw:: html + + + your html code here + + +These all are supported by GitHub very well. For more exhautive list specific to Sphinx see `this ` link. +