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をはじめよう 第二版」が出ます - Hack like a rolling stone
みなさん、Sphinx 使ってますか? Python や Linux カーネルのドキュメントでご存知の Sphinx の書籍、「Sphinxをはじめよう」が改訂されます。 今週末の #技術書典 で僕らが書いた #Sphinxをはじめよう の第二版が発売されます。しかも今回は紙媒体！(電子版もあるよ)。これからSphinxを触ってみようかなと思っている方におすすめです。細かな加筆をしているので、第一版をお持ちの方にもおすすめです。 #sphinxjp— Takeshi KOMIYA (@tk0miya) 2017年10月17日 #Sphinxをはじめよう の第二版は 1) Sphinx-1.6 に合わせて加筆 2) 基本のマークアップの説明をアップデート 3) みんな大好きmarkdownの説明をAppendixとして収録 4) 画像系のツール/サービスとの連携まわりの章を追加 とあれこれい
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
JUS関西 Sphinxワークショップ@関西 Sphinx事例紹介
2015/10/31に開催されたSphinxワークショップ@関西(https://japanunixsociety.doorkeeper.jp/events/32899)の発表資料です。Read less
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ページを開く
