MyST Parser

Parser MyST

MyST adalah varian Markdown yang kaya dan dapat diperluas yang dimaksudkan untuk dokumentasi teknis dan penerbitan .

MyST adalah jenis penurunan harga yang dirancang untuk kesederhanaan, fleksibilitas, dan ekstensibilitas. Repositori ini berfungsi sebagai referensi implementasi MyST Markdown, serta kumpulan alat untuk mendukung pekerjaan dengan MyST dengan Python dan Sphinx. Ini berisi parser yang diperluas sesuai CommonMark menggunakan markdown-it-py , serta ekstensi Sphinx yang memungkinkan Anda menulis MyST Markdown di Sphinx.

Lihat dokumentasi MyST Parser untuk informasi lebih lanjut .

Instalasi

Untuk menginstal parser MyST, jalankan perintah berikut di lingkungan Conda (disarankan):

conda install -c conda-forge myst-parser

atau

pip install myst-parser

Atau untuk pengembangan paket:

git clone https://github.com/executablebooks/MyST-Parser
cd MyST-Parser
git checkout master
pip install -e .[code_style,linkify,testing,rtd]

Untuk menggunakan parser MyST di Sphinx, cukup tambahkan: extensions = ["myst_parser"] ke conf.py Anda.

Berkontribusi

Kami menyambut semua kontribusi! Lihat Panduan Berkontribusi untuk lebih jelasnya.