Jello's development blog

Jello's development blog

reStructuredText

reStructuredText란?

마크업 언어의 일종으로, reST라고도 하고, 확장자는 .rst이다. markdown과 유사하게 내용만으로도 내용을 파악하기 쉽다는 장점이 있다. 실제로 Python의 docs(https://docs.python.org/3/)가 Python의 문서작성 도구인 Sphinx로 작성되었다.

특징

reStructuredText가 지향하는 목표는 다음과 같다.

  • Readable: 마크업언어에 대한 지식이 없어도 raw-form이 읽기 쉬워야 한다.
  • Unobtrusive: 문법이 최대한 단순하고 인위적이지 않아야 한다.
  • Unambigous: 문법이 모호하지 않고 반드시 하나의 입력형태는 하나의 출력형태으로만 나타나야 한다.
  • Unsurprising: 기대하는 결과가 나오게 한다.
  • Intuitive: 기억하기 쉽고 명확한 문법이여야 한다.
  • Easy: 어떤 텍스트 에디터에서도 작성하기 쉬워야 한다.
  • Scalable: 텍스트의 길이에 영향을 받지 않아야 한다.
  • Powerful: 문서화에 필요한 충분한 문법를 제공해야 한다.
  • Language-neutral: 영어뿐만아니라 모든 언어를 지원해야 한다.
  • Extentsible: 복합적인 마크업과 커스텀 마크업 추가가 쉬워야 한다.
  • Output-format-neutral: 특정 포맷에 치우치지 않고 다양한 출력포맷을 지원해야 한다.

문법(Syntax)

http://docutils.sourceforge.net/docs/user/rst/quickref.html 에 자세한 문법 설명이 나와있다.

참고문서