Consideration of introducing Markdown and decision of continuing reStructuredText#
In Sphinx + ablog, we considered writing articles in Markdown instead of reStructuredText.
It was confirmed that by introducing MyST-Parser, Sphinx can understand Markdown, and by making the following settings, it is also possible to post as a .md file.
extensions = [
"ablog",
"myst_parser",
]
myst_enable_extensions = [
"colon_fence",
"deflist",
"attrs_block",
"html_admonition",
"html_image",
"substitution",
"replacements",
]
On the Markdown side, you can give it the equivalent meaning of .. post:: by writing the following front-matter at the beginning.
---
title: Markdownで書いた記事
date: 2025-06-03
tags: [ablog, myst, markdown]
author: mtakagishi
---
Furthermore, it was confirmed that some Sphinx directives such as note, warning, and toctree can be reproduced in Markdown by using MyST notation.
:::note
これは注意書きです。
:::
However, when trying to get article ideas in Markdown format on ChatGPT, I encountered a problem where the chat field automatically rendered Markdown.
For example, a syntax like :::{note} will be expanded when the user tries to copy and paste, making it impossible to paste correctly. This is a UI design specification, and it is difficult for users to avoid it.
For this reason, we have determined that there are currently limits to editing and template design in Markdown in collaboration with ChatGPT.
Therefore, we will continue to use the .rst format for future articles.
Regarding Markdown notation, there will be room to reconsider it once Sphinx itself, ablog, and MyST evolve, and when ChatGPT’s Markdown output control means are improved.
—
I will keep this review record on my blog as a log of my own technical trials and errors and choices.
Article information
- author:
Mr. Takagi
- Release date:
2025-06-03