Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding electrical, programming, and how to rst guide #9

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
tabels
  • Loading branch information
RyanTaylor37 committed Jun 20, 2024
commit 2b7c3ce3d95d6ae1f8e391939f69faabf9a23302
56 changes: 42 additions & 14 deletions rst/how-to-use-rst.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,20 +121,48 @@ References to a :term:`term`.
Summary Table
-------------

+--------------+---------------------------------------------------------------+----------------------------------------------+
| **Element** | **Syntax Example** | **Description** |
+--------------+---------------------------------------------------------------+----------------------------------------------+
| **Title** | ``Title Level 1\n===========`` | Creates a title or section header |
| **Paragraph**| ``This is a paragraph.`` | Creates a paragraph |
| **Italic** | ``*Italic*`` | Creates italic text |
| **Bold** | ``**Bold**`` | Creates bold text |
| **List** | ``- Item 1\n- Item 2`` | Creates an unordered list |
| **Image** | ``.. image:: path/to/image.png\n :alt: Alt text`` | Embeds an image |
| **Video** | ``.. raw:: html\n <iframe src="URL"></iframe>`` | Embeds a video |
| **Link** | `` `Link text <http://example.com>`_ `` | Creates a hyperlink |
Summary Table
-------------

+--------------+------------------------------------------------------------+----------------------------------------------+
| **Element** | **Syntax Example** | **Description** |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Title** | ``Title Level 1\n===========`` | Creates a title or section header |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Paragraph**| ``This is a paragraph.`` | Creates a paragraph |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Italic** | ``*Italic*`` | Creates italic text |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Bold** | ``**Bold**`` | Creates bold text |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **List** | ``- Item 1\n- Item 2`` | Creates an unordered list |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Image** | ``.. image:: path/to/image.png\n :alt: Alt text`` | Embeds an image |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Video** | ``.. raw:: html\n <iframe src="URL"></iframe>`` | Embeds a video |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Link** | `` `Link text <http://example.com>`_ `` | Creates a hyperlink |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Table** | ``+---+---+\n| H1 | H2 |\n+===+===+\n| C1 | C2 |\n+---+---+`` | Creates a simple table |
| **Code** | ``::\n def func():\n print("code")`` | Creates a code block |
| **Directive**| ``.. note::\n This is a note.`` | Adds special content like notes or warnings |
+--------------+---------------------------------------------------------------+----------------------------------------------+
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Code** | ``::\n def func():\n print("code")`` | Creates a code block |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Directive**| ``.. note::\n This is a note.`` | Adds special content like notes or warnings |
+--------------+------------------------------------------------------------+----------------------------------------------+


Minimal Example

+--------------+------------------------------------------------------------+----------------------------------------------+
| **Element** | **Syntax Example** | **Description** |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Title** | ``Title Level 1\n===========`` | Creates a title or section header |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Paragraph**| ``This is a paragraph.`` | Creates a paragraph |
+--------------+------------------------------------------------------------+----------------------------------------------+
| **Italic** | ``*Italic*`` | Creates italic text |
+--------------+------------------------------------------------------------+----------------------------------------------+




Loading