Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TextileからMarkdownへ移行する #34

Open
kou opened this issue Nov 6, 2014 · 4 comments
Open

TextileからMarkdownへ移行する #34

kou opened this issue Nov 6, 2014 · 4 comments

Comments

@kou
Copy link
Member

kou commented Nov 6, 2014

TextileはMarkdownより表現力があるからTextileを選んだけど、Textileでも表現できないことが多いことがわかったので、より簡潔な表現のMarkdownに移行する。

表現力という点ではSphinx拡張付きのreStructuredTextが十分な表現力を持っているんだけど、Rubyのライブラリーのドキュメントを書くという点でのサポートがないので採用できない。

Markdown(GFM)でなんとかがんばる。

@kou
Copy link
Member Author

kou commented Nov 6, 2014

Textileのやつをリストアップしてサブissueにするのがよさそう。

@kou
Copy link
Member Author

kou commented Feb 14, 2015

新しく書くやつはMarkdownにしたい。

@myokoym
Copy link
Member

myokoym commented Apr 19, 2015

kramdownはデフォルトではGitHub Flavored Markdown(GFM)をサポートしていない。
ただ、YARDを使っているので整形済みテキストが常にRubyモードでシンタックスハイライトされる。
RedcarpetやkramdownのGFMパーサーを使えばGFMをサポートできそうだが、必要なさそう。

@myokoym
Copy link
Member

myokoym commented Apr 19, 2015

doc/textディレクトリー以下の移行は完了。
extディレクトリーやlibディレクトリー以下のソースコード内にはTextile記法が残っている。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants