Please don't write your documentation in Markdown
March 23, 2020 Please don't write your documentation in Markdown Please don't write your documentation in Markdown. Please. I'm begging you. Markdown is tolerable for short documentation, like a readme.md. Past that, it's the wrong tool for the job. Markdown is about formatting, not information Markdown is just a way to write simpler, nice looking HTML. There is direct mapping between _foo_ and <e
Sphinx から完全に reStructuredText を追い出した話 - Hack like a rolling stone
いくつかの記事で紹介されているとおり、 recommonmark を使うと Sphinx で markdown を使うことができます。 Software Design 2016年4月号 Markdownで始めるSphinx MarkdownでSphinxできるようになったので試してみた（前編） - 意識の高いLISPマシン Markdownで書けるSphinxの構築 - Qiita しかし、recommonmark を利用しても、ドキュメント構造(toctree)を記述するためには部分的に reStructredText を使う必要がありました。 .. toctree chapter1 chapter2 chapter3 これは、文法を拡張する仕組みを持たない markdown の (commonmark の)構造上、仕方がないのですが、せっかく markdown でドキュメントを書いてい
reStructuredText vs Markdown for documentation
In this post I am going to share my experience of using Markdown and reStructuredText (RST) for technical documentation. As a library developer I have to write a fair amount of it, for example, the fmt library documentation, and I’ve used both languages extensively. In fact, I’m writing this blog post in Markdown. At first sight RST and Markdown look very similar. Both are lightweight markup langu
[翻訳] reStructuredText ディレクティブ
著者: David Goodger 問い合わせ: goodger@python.org リビジョン: $Revision: 3340 $ 更新日時: $Date: 2005-05-14 18:14:44 +0200 (Sat, 14 May 2005) $ 著作権: This document has been placed in the public domain. 翻訳者: 清水川 貴之 shimizukawa at gmail.com 原文: http://docutils.sourceforge.net/docs/ref/rst/directives.html このドキュメントはreStructuredTextの文書解析器で実装されているディレクティブについて記述されています。 ディレクティブは以下の構文にで記述されます: +-------+--------------------
ReStructuredText 入門
以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" （構造化されたテキスト）という呼び方には、 いくぶん不適切なところがあると指摘しておきます。実際には、首尾一貫したパターンを使う "Relaxed Text" （形式ばらないテキスト）とでも呼ぶべきものです。そのパターンを HTML コンバータで変換することで、WEB ブラウザで扱えるような「非常に構造化された テキスト」が生成されるのです。 最も分かり易くて基本的なパターンは、 パラグラフ（段落） (quickref) です。 （1つ以上の）空行で区分されたテキストのひとかたまりが
Mac で mkdpreview-vim を使って reST のプレビューを見る - Study08.net 対シンバシ殲滅用人型機動兵器
mkdpreview-vim は Markdown記法で書かれたテキストを書きながら、別ウィンドウ上でプレビューも一緒に確認できる便利プラグイン。 mattn/mkdpreview-vim - GitHub Big Sky :: Vimで編集中のMarkdownをプレビュー出来るプラグイン書いた Markdown以外に、reST と textile にも対応している。 これを利用してMacOS X 上で reSTructuredTextのプレビューを見てみる。 以下 プレビューを表示するまで。 環境 MacOS X pyqtのインストール 時間かかるんで最初にインストールしておく。 面倒なのでhomebrewでまるっとインストール $ brew install pyqt Qt と sit と PyQT4 を一気にインストールするから、多分 20~30分くらい時間かかる。 インストールが完了
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
