From f76fa8850298b19f013e33f28dc6cd88049032f0 Mon Sep 17 00:00:00 2001 From: MurakamiShinyu Date: Fri, 8 Nov 2024 21:42:58 +0900 Subject: [PATCH] =?UTF-8?q?=E3=82=AD=E3=83=A5=E3=83=A1=E3=83=B3=E3=83=88?= =?UTF-8?q?=E3=83=9A=E3=83=BC=E3=82=B8=E3=81=AE=E6=9B=B4=E6=96=B0=EF=BC=9A?= =?UTF-8?q?Vivliostyle=20CLI=E3=81=AE=E6=96=B0=E3=83=89=E3=82=AD=E3=83=A5?= =?UTF-8?q?=E3=83=A1=E3=83=B3=E3=83=88=E3=81=B8=E3=81=AE=E3=83=AA=E3=83=B3?= =?UTF-8?q?=E3=82=AF=E3=81=AA=E3=81=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ドキュメントページを更新しました。更新内容は以下の通りです。 - Vivliostyle CLIの新ドキュメントへのリンク - 従来の Vivliostyle CLI ユーザーガイド (https://docs.vivliostyle.org/#/ja/vivliostyle-cli) の内容が古くなり、新しいドキュメントが https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/index.md に作られているため、新しいドキュメントを参照するように直しました。 - ドキュメント内の見出しを集めたリストを作るためのスクリプト（`_includes/fetch-guide-urls.html` 内）を修正し、新しいドキュメントの見出しへのリンクのURLフラグメントが正しくなるようにしました。 - 「リファレンス」を「コントリビューションガイド」より先に表示するようにしました。ユーザーが必要とする情報が先で、開発に貢献したい人向けの情報が後にあるほうがよいと考えたためです。 - ユーザーガイドの各プロダクトの見出し（「Vivliostyle Viewer」「Vivliostyle CLI」など）は各プロダクトのドキュメントのトップへのリンクになっているようにしました。 --- _includes/fetch-guide-urls.html | 3 +- _includes/page/documents.html | 6 +++ documents.md | 75 +++++++++++++++++++++++++++---- ja/documents.md | 79 ++++++++++++++++++++++++++++----- 4 files changed, 142 insertions(+), 21 deletions(-) diff --git a/_includes/fetch-guide-urls.html b/_includes/fetch-guide-urls.html index c673972c26..f955d9d492 100644 --- a/_includes/fetch-guide-urls.html +++ b/_includes/fetch-guide-urls.html @@ -16,7 +16,8 @@ } function listTemplate(name, base_url) { - const anchor = name.toLowerCase().replace(/\s/g, "-").replace(/[()\/\.]/g, ""); + const anchor = name.toLowerCase().replace(/\s/g, "-").replace( + base_url.startsWith("https://github.com/") ? /[()\/\.（）「」]/g : /[()\/\.]/g, ""); return `
  • diff --git a/_includes/page/documents.html b/_includes/page/documents.html index 3dc4d61d69..3a563580d2 100644 --- a/_includes/page/documents.html +++ b/_includes/page/documents.html @@ -12,6 +12,12 @@ +
    +
    + {{ include.contribution | markdownify }} +
    +
    +
    {{ include.plan | markdownify }} diff --git a/documents.md b/documents.md index adc9647360..5d3068f5c3 100644 --- a/documents.md +++ b/documents.md @@ -8,7 +8,7 @@ title: Documents ## 📖 User Guides {% include fetch-guide-urls.html %} -### Vivliostyle Viewer +### [Vivliostyle Viewer](https://docs.vivliostyle.org/#/vivliostyle-viewer)
      {% include fetch-guide-url.html id="vivliostyle-viewer-list" @@ -16,15 +16,65 @@ title: Documents get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/vivliostyle-viewer.md" %} -### Vivliostyle CLI -
        +### [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/index.md) + +{% include fetch-guide-url.html + id="vivliostyle-cli-getting-started-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/getting-started.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/getting-started.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-themes-and-css-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/themes-and-css.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/themes-and-css.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-using-config-file-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/using-config-file.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/using-config-file.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-toc-page-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/toc-page.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/toc-page.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-cover-page-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/cover-page.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/cover-page.md" +%} {% include fetch-guide-url.html - id="vivliostyle-cli-list" - url="https://docs.vivliostyle.org/#/vivliostyle-cli" - get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/vivliostyle-cli.md" + id="vivliostyle-cli-special-output-settings-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/special-output-settings.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/special-output-settings.md" %} -### Create Book +### [Create Book](https://docs.vivliostyle.org/#/create-book)
          {% include fetch-guide-url.html id="create-book-list" @@ -32,21 +82,24 @@ title: Documents get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/create-book.md" %} -### Vivliostyle Themes +### [Vivliostyle Themes](https://vivliostyle.github.io/themes/#/) -### Vivliostyle Flavored Markdown (VFM) +### [Vivliostyle Flavored Markdown (VFM)](https://vivliostyle.github.io/vfm/#/vfm)
            {% include fetch-guide-url.html id="vfm-list" url="https://vivliostyle.github.io/vfm/#/vfm" get_url="https://api.github.com/repos/vivliostyle/vfm/contents/docs/vfm.md" %} +{% endcapture %} + +{% capture contribution %} ## 🛠 Contribution Guides ### Vivliostyle.js @@ -73,6 +126,9 @@ title: Documents - [Supported CSS Features](https://docs.vivliostyle.org/#/supported-css-features) - [Core API Reference](https://docs.vivliostyle.org/#/api) +- Vivliostyle CLI API Reference + - [Config Reference](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/config.md) + - [JavaScript API](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/api-javascript.md) {% endcapture %} @@ -110,6 +166,7 @@ Vivliostyle project discusses development matters on Slack. guide=guide reference=reference + contribution=contribution plan=plan community=community %} diff --git a/ja/documents.md b/ja/documents.md index db8bcbbf51..23d60ba4f1 100644 --- a/ja/documents.md +++ b/ja/documents.md @@ -9,7 +9,7 @@ lang: ja ## 📖 ユーザーガイド {% include fetch-guide-urls.html %} -### Vivliostyle Viewer +### [Vivliostyle Viewer](https://docs.vivliostyle.org/#/ja/vivliostyle-viewer)
              {% include fetch-guide-url.html id="vivliostyle-viewer-list" @@ -17,15 +17,65 @@ lang: ja get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/ja/vivliostyle-viewer.md" %} -### Vivliostyle CLI -
                +### [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/index.md) + +{% include fetch-guide-url.html + id="vivliostyle-cli-getting-started-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/getting-started.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/getting-started.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-themes-and-css-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/themes-and-css.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/themes-and-css.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-using-config-file-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/using-config-file.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/using-config-file.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-toc-page-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/toc-page.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/toc-page.md" +%} +{% include fetch-guide-url.html + id="vivliostyle-cli-cover-page-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/cover-page.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/cover-page.md" +%} {% include fetch-guide-url.html - id="vivliostyle-cli-list" - url="https://docs.vivliostyle.org/#/ja/vivliostyle-cli" - get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/ja/vivliostyle-cli.md" + id="vivliostyle-cli-special-output-settings-list" + url="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/special-output-settings.md" + get_url="https://api.github.com/repos/vivliostyle/vivliostyle-cli/contents/docs/ja/special-output-settings.md" %} -### Create Book +### [Create Book](https://docs.vivliostyle.org/#/ja/create-book)
                  {% include fetch-guide-url.html id="create-book-list" @@ -33,21 +83,24 @@ lang: ja get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/ja/create-book.md" %} -### Vivliostyle Themes +### [Vivliostyle Themes](https://vivliostyle.github.io/themes/#/ja/) -### Vivliostyle Flavored Markdown (VFM) +### [Vivliostyle Flavored Markdown (VFM)](https://vivliostyle.github.io/vfm/#/ja/vfm)
                    {% include fetch-guide-url.html id="vfm-list" - url="https://vivliostyle.github.io/vfm/#/vfm" - get_url="https://api.github.com/repos/vivliostyle/vfm/contents/docs/vfm.md" + url="https://vivliostyle.github.io/vfm/#/ja/vfm" + get_url="https://api.github.com/repos/vivliostyle/vfm/contents/docs/ja/vfm.md" %} +{% endcapture %} + +{% capture contribution %} ## 🛠 コントリビューションガイド ### Vivliostyle.js @@ -74,6 +127,9 @@ lang: ja - [サポートする CSS 機能](https://docs.vivliostyle.org/#/ja/supported-css-features) - [Core API リファレンス](https://docs.vivliostyle.org/#/ja/api) +- Vivliostyle CLI API リファレンス + - [Config Reference](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/config.md) + - [JavaScript API](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/api-javascript.md) {% endcapture %} @@ -111,6 +167,7 @@ Vivliostyle プロジェクトでは、開発方針などをSlack上で話し合 guide=guide reference=reference + contribution=contribution plan=plan community=community %}