Skip to content
Snippets Groups Projects
Commit 6d147683 authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

Update reStructuredText Basics.rst

parent 6dc1bad0
No related branches found
No related tags found
No related merge requests found
What is reStructuredText? What is reStructuredText?
============================= =============================
reStructuredText is an easy to read, what-you-see-is-what-you-get plainttext markup syntax and parser system. In other words reStructuredText is a lightweight markup language that is used in static site generators like Sphinx. reStructuredText is an easy to read, what-you-see-is-what-you-get plainttext markup syntax and parser system. In other words reStructuredText is a lightweight markup language that is used in static site generators like Sphinx.
It contains robust tools for semantic markup, reusing content, and content filters for different kinds of outputs. It’s also easily extendible using custom directives that you can create yourself, allowing you to satisfy a wide variety of documentation needs. It contains robust tools for semantic markup, reusing content, and content filters for different kinds of outputs. It’s also easily extendible using custom directives that you can create yourself, allowing you to satisfy a wide variety of documentation needs.
...@@ -9,6 +10,7 @@ reStructuredText is useful for creating simple web pages, and for standalone doc ...@@ -9,6 +10,7 @@ reStructuredText is useful for creating simple web pages, and for standalone doc
Why use reStructuredText? Why use reStructuredText?
============================= =============================
reStructuredText is a lightweight markup language, so it’s easier to read in plain-text format compared to heavier markup languages like DITA and other XML-based formats. reStructuredText is a lightweight markup language, so it’s easier to read in plain-text format compared to heavier markup languages like DITA and other XML-based formats.
You can easily find text editors that render reStructuredText with syntax highlighting and live previews, without having to invest in complex tools. Compared to some other lightweight markup languages like markdown, reStructuredText contains stronger semantic markup tools. You can easily find text editors that render reStructuredText with syntax highlighting and live previews, without having to invest in complex tools. Compared to some other lightweight markup languages like markdown, reStructuredText contains stronger semantic markup tools.
...@@ -129,6 +131,7 @@ this unordered list: ...@@ -129,6 +131,7 @@ this unordered list:
Images Images
========== ==========
reSt supports an image directive, used like: .. figure:: Images/image name.PNG reSt supports an image directive, used like: .. figure:: Images/image name.PNG
*example* *example*
...@@ -138,6 +141,7 @@ reSt supports an image directive, used like: .. figure:: Images/image name.PNG ...@@ -138,6 +141,7 @@ reSt supports an image directive, used like: .. figure:: Images/image name.PNG
Directives Directives
============== ==============
Directive is a generic block of explicit markup. While docutils provides a number of directives, sphinx provides many more and uses directives as one of the primary extension mechanism. Directive is a generic block of explicit markup. While docutils provides a number of directives, sphinx provides many more and uses directives as one of the primary extension mechanism.
*example* *example*
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment