vivliostyle / vivliostyle.org

Source code of the vivliostyle.org website
https://vivliostyle.org
MIT License
8 stars 4 forks source link

最近のVivliostyle更新を反映したサイト見直し #72

Open MurakamiShinyu opened 3 years ago

MurakamiShinyu commented 3 years ago

最近のVivliostyle更新を反映したサイト見直しが必要です。 とくにCLIのpreviewコマンドでViewerが使われることになったことにより、ViewerをローカルWebサーバーで使う必要性はあまりなくなり、ローカルでCSS組版結果を確認・閲覧したい用途には、CLIを使ってもらう方がよいだろうと思います。

以下、現状のサイトで直したいところです: (日本語ページについて書きますが、もちろん英語ページも同様)

トップページ https://vivliostyle.org/ja/

Vivliostyle Viewer はブラウザから、Vivliostyle CLI はコマンドラインから HTML ファイルを読み込み、CSS で組版後、PDF に書き出せます。

"HTML" → "HTML または Markdown"

使ってみる https://vivliostyle.org/ja/getting-started/

Vivliostyle Viewer よりも Vivliostyle CLI を先にしたほうがよいのではないか。

Vivliostyle Viewer https://vivliostyle.org/getting-started/#vivliostyle-viewer

ローカルのファイルを組版・表示するには、webサーバー起動が必要です(くわしくはFAQをご覧ください)。

それよりも、Vivliostyle CLI の preview コマンドで Vivliostyle Viewer が使われるようになったので、それをおすすめしたい

Vivliostyle CLI https://vivliostyle.org/getting-started/#vivliostyle-cli

ユーザーガイドへのリンク https://docs.vivliostyle.org/#/ja/vivliostyle-cli が必要。

Markdown (VFM)からの組版について書かれていない。ユーザーガイドの「Markdown から PDF を生成」を参照でもよい。

Preview のスクリーンショットが古い。 Vivliostyle Viewer が起動することを説明するとよいだろう。

ダウンロード https://vivliostyle.org/ja/download/

最初に Vivliostyle CLI のインストール方法を書くのがよいだろう。 「Vivliostyleをダウンロードして使いたい」というユーザーには、Vivliostyle Viewer をローカルWebサーバーで使うことよりも Vivliostyle CLI を使うことを勧めたいので。

ドキュメント https://vivliostyle.org/ja/documents/

Vivliostyle Viewer よりも Vivliostyle CLI を先にしたほうがよいのではないか。

リファレンスで重要なのは「サポートする CSS 機能」なので、「Core API リファレンス」の前に直す

https://docs.vivliostyle.org のドキュメントの内容もいろいろ見直しが必要(要検討)

FAQ https://vivliostyle.org/ja/faq/

いろいろ見直し・追加が必要(要検討)

ogwata commented 3 years ago

項目ごとに、優先順位を考えましょう。 どれが最優先でしょう。

yamasy1549 commented 3 years ago

FAQ、使ってみる を先に直したいですね。特にFAQを最優先にしたいです。

ogwata commented 3 years ago

なるほど、進め方としてもFAQから手をつけるのはやりやすい気がします。

ただ、目に見える効果は低めかな。その意味からは、トップベースから手をつける考え方もあります。

村上さん、優先順位についてどうでしょう。

MurakamiShinyu commented 3 years ago

FAQ、使ってみる を先に直したいですね。特にFAQを最優先にしたいです。

に同意です。 FAQは現在、「Vivliostyle Viewer についての FAQ」がトップで、その最初の項目が「ローカル環境で Vivliostyle Viewer を使うには?」ですが、「Vivliostyle CLI についての FAQ」のほうをトップにして、ローカル環境で Vivliostyle Viewer を使う方法として CLI の preview を使うことを書くとよさそうですね。