RST cheat sheet¶

Tiêu đề¶

=========
Heading 1
=========

Heading 2
=========

Heading 3
---------

Heading 4
~~~~~~~~~

Heading 5
*********

Heading 6
^^^^^^^^^

Ghi chú

Mỗi trang phải có duy nhất một Heading 1. Không hơn, không kém.
Đường gạch chân (ví dụ ===) phải rộng bằng hoặc hơn tiêu đề.

Kiểu chữ¶

RST	Kết quả
Bold	Bold
Italic	Italic

Danh sách¶

Danh sách không theo thứ tự¶

RST¶

* Item 1.
* Item 2.
  This is the last item.

Kết quả¶

Item 1.
Item 2. This is the last item.

Ghi chú

Các mục bắt đầu với *, - hoặc +.
Các dòng phải được căn lề. Ví dụ "Item 2." và "This is the last item." được căn lề.

Danh sách theo thứ tự¶

RST¶

#. Item 1.
#. Item 2.
   This is the last item.

Kết quả¶

Item 1.
Item 2. This is the last item.

Ghi chú

Các mục bắt đầu với một trong các kiểu #., 1., a. hoặc A.. Khuyến khích sử dụng #..
Các dòng phải được căn lề. Ví dụ "Item 2." và "This is the last item." được căn lề.

Danh sách lồng nhau¶

RST¶

* Item 1.

  #. Item 1A.
  #. Item 1B.

Kết quả¶

Item 1.
1. Item 1A.
2. Item 1B.

Siêu liên kết¶

Liên kết ngoài¶

Cú pháp¶

`nhãn <URL>`_

Ghi chú

URL có thể là đường dẫn tương đối đến một tập tin trong tài liệu.

Ví dụ¶

RST¶

`Viindoo website <https://viindoo.com>`_

Kết quả¶

Viindoo website

Trang nội bộ¶

Tạo một liên kết tới một trang trong tài liệu thông qua đường dẫn tương đối.

Cú pháp¶

:doc:`path_to_page`: tạo một liên kết với nhãn là tiêu đề của trang.
:doc:`label <path_to_page>`: tạo một liên kết với nhãn riêng.

Ví dụ¶

RST¶

Please refer to :doc:`../../applications/websites`.

Kết quả¶

Please refer to Websites.

Đích nội bộ¶

Tạo một liên kết tới một nơi trong tài liệu được định nghĩa bởi một đích.

Cú pháp¶

Định nghĩa một đích bằng .. _targetName:

Có hai cách để tạo một liên kết đến đích:

:ref:`targetName`: tạo một liên kết với nhãn là tên đích.
:ref:`label <targetName>`: tạo một liên kết với nhãn riêng.

Ví dụ¶

RST¶

Pricing
^^^^^^^

See :ref:`FAQ <contributing/internal-target/example-faq>`.

.. _contributing/internal-target/example-faq:

Frequently Asked Questions
^^^^^^^^^^^^^^^^^^^^^^^^^^

* What is the difference between On-Premise and Viindoo SaaS?

Kết quả¶

Pricing¶

See FAQ.

Frequently Asked Questions¶

What is the difference between On-Premise and Viindoo SaaS?

Ảnh¶

Cú pháp image cho phép chèn ảnh.

Cú pháp¶

.. image:: path|url

Với tham số tùy chọn:

.. image:: path|url
   :align: top|middle|bottom|left|center|right
   :alt: alternate text
   :height: length
   :width: length or percentage of the content width
   :scale: percentage
   :target: hyperlink reference (uri or reference name)

Ví dụ¶

RST¶

.. image:: img/viindoo.png
   :align: center
   :alt: Viindoo Logo
   :target: https://viindoo.com

Kết quả¶

Bảng¶

RST¶

+---------------+--------------+
| Header        | Header       |
+===============+==============+
| Cell          | Cell         |
+---------------+--------------+
| Cell          | Cell         |
+---------------+--------------+

Kết quả¶

Header	Header
Cell	Cell
Cell	Cell

Mẹo

Sử dụng công cụ tạo bảng này để tạo bảng dễ dàng hơn.

Thông báo¶

Xem thêm¶

RST¶

.. seealso::
   - :doc:`../../applications/websites`

Kết quả¶

Xem thêm

Websites

Ghi chú¶

RST¶

.. note::
   This is a note.

Kết quả¶

Ghi chú

This is a note.

Mẹo¶

RST¶

.. tip::
   A small but useful piece of practical advice.

Kết quả¶

Mẹo

A small but useful piece of practical advice.

Cảnh báo¶

RST¶

.. warning::
   This is a warning.

Kết quả¶

Cảnh báo

This is a warning.

Tùy biến¶

RST¶

.. admonition:: Title

This a custom alert.

Kết quả¶

Title

This is a custom alert.

Code Block¶

Sử dụng cú pháp .. code-block:: để chèn code mẫu.

RST¶

.. code-block:: python

   class Person:
       def walk_to_work():
           pass

Kết quả¶

class Person:
    def walk_to_work():
        pass

Siêu dữ liệu trang¶

Có một số chỉ thị siêu dữ liệu để cấu hình hành xử của cả một trang. Chúng phải được đặt ở đầu trang.

Directive	Mean
`:hide-content:`	Ẩn nội dung của trang khi truy cập.
`:display-toc:`	Hiển thị mục lục trên trang.
`:hide-local-toc:`	Ẩn mục lục bên phải trang ("Trên trang này").
`:nosearch:`	Loại trừ một trang từ kết quả tìm kiếm.