1.2.3

## How-To - Write Documentation

This page was machine translated. Please help us improve it.

See How-To - Translate Documentation

Rubiniusのドキュメントは、Webサイトやブログに統合されています。これは、使用して Jekyllは単に他のコンポーネントと同様に。

開始するには、`kramdown`は、インストール`jekyll`宝石を持っていることを確認します。

    rbx gem install jekyll kramdown

ドキュメントのソースは、`web/doc`のディレクトリの下にあります。があります。 各言語のサブディレクトリは、ドキュメントがされていると （例：`en`は、`ja`を、など）が翻訳されています。

目次は、例えば各翻訳（のためにそこにいる `/web/doc/ja/index.markdown`に）。ドキュメントの残りの部分は、構成されています YAMLはドキュメントがどのように指定する属性を持つ単一のファイル 接続されています。基本的には、マニュアルのように表示することができます二重にリンクされている を指して、各ドキュメントとドキュメントのリストを前と次の ドキュメント。内容文書の表は、完全な構造を示しています。

YAMLは次のようなドキュメントを見ての属性：

    ---
    layout: doc_en
    title: How-To - Write Documentation
    previous: Write a Blog Post
    previous_url: how-to/write-a-blog-post
    next: Translate Documentation
    next_url: how-to/translate-documentation
    ---

layoutの書式設定時に使用するジキルのレイアウトを指定する ドキュメント。 layoutは`doc_LANGする必要があります、LANGは、ISO- 639- 2です 言語のコード。

titleの上部に表示されている文書のタイトルを指定します。 ページを表示します。

previousとprevious_url属性は、タイトルとリンクを与える 以前のドキュメント。同様に、nextとnext_url属性を与える タイトルと、次のドキュメントのリンクをクリックします。これらは、閲覧を強化するために使用されている ドキュメントや作業量を再注文部品の必要な制限 マニュアルを参照してください

### 編集既存のドキュメントを

ドキュメントの最初のアウトラインが作成されています。たくさんいる 単に必要なトピックでは、それらのために書かれたドキュメントを持っている。

既存のトピックのドキュメントを追加する、または既存のドキュメントを修正する `web/doc/LANG`は下のトピックのファイルを開いて、追加または改善 マニュアルを参照してください

### 新しいドキュメントを追加する

既存のトピックでは、存在するのドキュメントを追加するには：

1. Create a new file with the .markdown extension under `web/doc/LANG`.
2. Set up the attributes to link the new file into the existing files. This will require editing the previous and next attributes of the existing files to insert the new file, as well as adding an entry to `index.markdown`.
3. To view your updates while you are working on them, run `rbx -S jekyll --server --auto`
4. Edit the new file using Markdown syntax.
5. In the `web/` directory, run `rbx -S jekyll`.
6. Commit all the changes in the `web/` directory.