-
Notifications
You must be signed in to change notification settings - Fork 9
Dev center cli
Dev Center CLIは著者がDev Centerの記事をローカルでプレビューしたり編集することを許可します。
あなたのローカルマシン上でRubyを設定する必要があります。そのあと、Dev Center CLI Gem をインストールしてください :
$ gem install devcenter
devcenter pull
の後に記事のURLを追加して、記事のコピーをローカルにダウンロードします :
$ devcenter pull https://devcenter.heroku.com/articles/dev-center-cli
"Dev Center CLI" article saved as ~/.../dev-center-cli.md
これで、dev-center-cli.md
というテキストファイルがあなたのローカルのディレクトリに保存されました。
テキストエディタでファイルを開きます。マークダウン形式で書かれた記事の内容の後に、いくつかのメタデータが含まれている事に気付くと思います。
以下のコマンドで、あなたのデフォルトのブラウザでプレビューを確認することができます :
$ devcenter preview dev-center-cli
Live preview for error-pages available in http://127.0.0.1:3000/dev-center-cli
It will refresh when you save ~/.../dev-center-cli.md
Press Ctrl+C to exit...
では、記事の内容の編集を初めて見ましょう。ファイルを保存するといつでもプレビューは自動でリフレッシュされるので、編集をしている内容とプレビューを平行して確認する事が出来ます。
マークダウンファイルはいくつかのメタデータの領域を含んでおり、以下の物は編集可能です :
-
title
: 自由に編集する事が出来ます。 -
markdown_flavour
: 内容をパースするのに使われるべき、DevCenterで利用可能な2種類のマークダウンパーサを指定します。利用可能な値はmaruku
(特に指定がない場合はデフォルトとして適応されます)、そしてgithub
(新しく実験として使っている同等のパーサー)です。
warning idの上書きは決して行わないでください。DevCenter内であなたの変更を保存する必要が出てきます。
プレビュー画面の最後に、Dev Centerのウェブサイト内で、変更を保存するためのボタンを確認できると思います。
warning Dev Centerへ記事を保存するためにはログインする必要があります。
ボタンをクリックしたあと、Dev Center内の編集フォームへリダイレクトされ、ローカルの変更が事前にそこへ反映され、記事の保存が出来る状態になっています。
preview
コマンドを終了するには、 Ctrl+Cを押してください。
利用可能なコマンドの全てのリストを得るためには、以下のコマンドを実行します :
$ devcenter help
特定のコマンドと利用可能なオプションに関するヘルプを得る場合、例えばpreview
なら :
$ devcenter help preview
Dev Center CLIはオープンソースなので、リポジトリにアクセスして、コードを得る事ができ、イシューを上げたり、プルリクエストを送る事が出来ます。