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
ふだん Markdown を書く技術者のための reStructuredText 文法まとめ
ふだんは Markdown を書いていて、稀に reStructuredText を書く必要がある技術者（私です）のための reStructuredText 文法まとめです。 reStructuredText のすべてを網羅するのではなく、あくまで「 Markdown にある機能を reStructuredText で使いたい」という状況を想定した上での簡易的なまとめです。 reStructuredText の詳細を本格的に学びたい場合は次の 2 つのページを参照することをおすすめします。 reStructuredText Primer — Sphinx documentation reStructuredText 「 Markdown なら書き方がわかっているんだけど、 reStructuredText でどう書けばいいかわからないので、いちいち検索してしまう」という方のお役に立てば幸い
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
GoのreStructuredTextパーサgorstをリリースしました | hexacosa.net
タイトルどおりですが、GoのreStreucturedText実装を作ってみました。 https://github.com/hhatto/gorst 以前 GoでMarkdown live previewerのftcatってのを作った のですが、 リリースしたあとくらいに reStructuredText でも使いたいよなーって思ってました。 よしGoのreSTパーサ作ろうと思って 10月下旬にGitHubに空のリポジトリだけ作って 、 どこから手をつけたらいいのやらってグダグダ考えてほったらかしになっていたのですが、 2月に入ってちびちびと余暇の時間を使って進めて、やっと公開できるレベルになって公開したのが先日2/18でした。 使い方 現在はreSTからHTMLへの変換のみ対応しています。 現状はHTML以外のフォーマットに対応させる予定はありません。 $ go get github.c
多様なフォーマットに対応！ドキュメント変換ツールPandocを知ろう - Qiita
追記（2020.4.19） Pandoc User’s Guideを日本語に全訳しました。 よろしければご参照ください。 新しい翻訳をプレリリースしました！（翻訳途中の部分もあります） Pandocユーザーズガイド 日本語版 [2.7.2] — 日本Pandocユーザ会 2019.02.21 ドキュメント 旧日本語版：Pandoc ユーザーズガイド 日本語版 はじめに 今回は、ドキュメント作成Tips Advent Calendar 2012の1日目 （マインドマップから全てを紡ぎ出す - XMind+Pandocのドキュメント作成術 -） で少し紹介したPandocというツールについて、もう少し深く掘り下げて紹介したいと思います。 MarkdownとかreStructuredTextとか、流行ってますよね いわゆる軽量マークアップ言語が最近流行しています。特にMarkdownは猫も杓子も
mooをフォークしてmeowをリリースしました | hexacosa.net
以前紹介した markdownファイルをリアルタイムプレビューできるツール moo 。 現在はJavaScriptをベースにしたツールに変わってしまったため、 reStructuredTextファイルも変換できるようにしたPython版をフォークして meow としてリリースしました。 mooの作者とのやり取りは このあたり 。 Python3でも動作します。 コードはGitHubにあげています 。 インストールと使い方 インストール $ pip install meow 起動。 $ meow REST.rst Preview on http://127.0.0.1:7777 Hit Ctrl-C to quit. 2013-06-22 00:37:21 INFO detected file change Ctrl+Cで停止します。 一度使ってみてください。では。
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ページを開く
