- 基本的には GitHub Flavored Markdown になっています。
- (システムとして制限はしていないが、) 変換先は素の HTML だけではないので、HTML 埋め込みなどの HTML 以外への変換で問題になる機能は使わないでください。
refeコマンドのように、そのまま表示する用途もあるので、変換前の見た目も読みやすさに気をつけてください。
- YAML front matter でファイル全体に関わるメタデータが書けます。
category,require,sublibraryに対応しています。(RD ではファイルの冒頭に書いていた情報になります。)
例:
---
category: Development
---
Ruby向けのPower Assertを提供するライブラリです。
---
require: bigdecimal
---
LU 分解を用いて、連立1次方程式 Ax = b の解 x を求める機能を提供します。
---
require:
- rubygems/defaults
- rubygems/exceptions
- rubygems/version
- rubygems/requirement
- rubygems/dependency
- rubygems/gem_path_searcher
- rubygems/source_index
- rubygems/platform
- rubygems/builder
sublibrary: rubygems/gem_runner
---
RubyGems を扱うためのクラスやモジュールが定義されているライブラリです。
headingsは# fooの形式のみを使ってください。(# foo #や setext heading は使わないでください。)- レベル 1 ブロックやレベル 2 ブロックなどの見出しは RD と同じです。
- RD の
---で始まる行のMethodListに相当するメソッド定義は### def method(arg1, arg2)のように### defに続けて通常のメソッド定義の構文で書きます。 - グローバル変数は
defをつけずに### $DEBUGのように書きます。
例:
# reopen Kernel
## Special Variables
### $ERROR_INFO -> Exception | nil
class ブロックと module ブロックなどの冒頭の alias, extend, include の記法は未定です。
基本的には GitHub Flavored Markdown になっているので、箇条書きなどは Markdown の記法を使ってください。
ハイパーリンクの記法の [] を1段減らして、[c:String] や [m:String#dump] のように書いてください。
[[url:https://example.com]] は [url:https://example.com] も使えますが、通常の Markdown の <https://example.com> や [例示ドメイン](https://example.com) という記法でも構いません。
例:
### $ERROR_INFO -> Exception | nil
[m:$!] の別名
プリプロセッサの記法は使えません。
Liquid を使っているので、詳しい機能はLiquid for Designersを参照してください。
{% comment %} と {% endcomment %} か {%- # this is an inline comment -%} を使ってください。
<!-- HTML のコメント --> は refe などで参照したときにそのまま見えてしまうので、避けてください。
対応予定ですが、まだ対応してません。
since と until は未対応です。
if で明示的に書いてください。
{% if version > '2.6.0' %}
ここに version > 2.6 の話を書く
{% endif %}
code block で書いてください。 ラベルは対応予定ですが、まだ対応していません。
```ruby
ruby code
## メソッドシグネチャの文法
基本的な記述内容は[HowToWriteMethodEntry](https://github.com/rurema/doctree/wiki/HowToWriteMethodEntry)を参照してください。
「`@param pattern 検索するパターンです。`」の行は「`* *param* pattern -- 検索するパターンです。`」の形式に変更予定です。