rst (reStructuredText) 문법
- 1 minrst
rst는 마크업 언어의 일종이다.
마크업언어는 문서의 내용을 논리적인 구조로 쉽게 표현할 수 있도록 문법을 제공하는 언어로,
쉽게말해서 HTML이나 markdown같이 어떤 문서의 내용을 좀 이쁘게 정리할 수 있게 도와주는 녀석이다.
크게 중요한건 아니니 바로 본론으로 들어가 rst의 문법을 알아보자.
아, 참고로 rst는 파이썬 공식 문서를 작성하는데도 사용되었다.
문법
나도 당장 실무에 써먹기위해 조금씩 공부하며 정리중인 글이므로, 당장 모든 문법이 정리되어있진 않을것이다.
우선 내가 자주 사용하는 문법을 기준으로 차근차근 업데이트해나가도록 하겠다.
섹션 수준 나누기
섹션 수준은 다음과 같이 나누면 된다.
마크다운의 #, ##, ### 와 비슷한 기능이라고 생각하면 된다.
아래로 갈수록 저수준이다.
===============
Section Title
===============
---------------
Section Title
---------------
Section Title
=============
Section Title
-------------
Section Title
'''''''''''''
Section Title
.............
Section Title
~~~~~~~~~~~~~
Section Title
*************
Section Title
+++++++++++++
Section Title
^^^^^^^^^^^^^
들여쓰기
들여쓰기는 다음과 같이 해주면 된다.
- 1단계 들여쓰기
- 네 칸을 띄고 쓰면 2단계 들여쓰기
- 이런식으로 4칸씩 띄어주면 된다
- 다시 1단계 들여쓰기
- 2단계
- 다시 1단계
코드블록
코드 관련 블록을 넣으려면 다음과 같이 하면 된다.
마크다운의 ``` 라고 생각하면 된다.
.. code::
# 이곳은 코드블록입니다.
print("hello, rst!")
이미지
이미지는 다음과 같이 넣어주면 된다.
.. image:: 이미지경로
:height: 250
:width: 250
:scale: 50
:alt: 이미지 설명
표
표는 다음과 같이 두 가지 형태로 표현 가능하다.
+------------+------------+-----------+
| Header 1 | Header 2 | Header 3 |
+============+============+===========+
| body row 1 | column 2 | column 3 |
+------------+------------+-----------+
| body row 2 | Cells may span columns.|
+------------+------------+-----------+
| body row 3 | Cells may | - Cells |
+------------+ span rows. | - contain |
| body row 4 | | - blocks. |
+------------+------------+-----------+
===== ===== ======
Inputs Output
------------ ------
A B A or B
===== ===== ======
False False False
True False True
False True True
True True True
===== ===== ======
표를 그리는데 있어서는 md보다 좀 더 유연한 문법을 제공하는 것 같다.
코딩장이
-장이: [접사] ‘그것과 관련된 기술을 가진 사람’의 뜻을 더하는 접미사.