Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ドキュメントページの更新：Vivliostyle CLIの新ドキュメントへのリンクなど #158

Merged
merged 1 commit into from
Nov 15, 2024
Merged

ドキュメントページの更新：Vivliostyle CLIの新ドキュメントへのリンクなど #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _includes/fetch-guide-urls.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 `
<li>
Expand Down
6 changes: 6 additions & 0 deletions _includes/page/documents.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@
</div>
</section>

<section class="section">
<div class="container">
{{ include.contribution | markdownify }}
</div>
</section>

<section class="section">
<div class="container">
{{ include.plan | markdownify }}
Expand Down
75 changes: 66 additions & 9 deletions documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,45 +8,98 @@ title: Documents
## 📖 User Guides
{% include fetch-guide-urls.html %}

### Vivliostyle Viewer
### [Vivliostyle Viewer](https://docs.vivliostyle.org/#/vivliostyle-viewer)
<ul id="vivliostyle-viewer-list"></ul>
{% include fetch-guide-url.html
id="vivliostyle-viewer-list"
url="https://docs.vivliostyle.org/#/vivliostyle-viewer"
get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/vivliostyle-viewer.md"
%}

### Vivliostyle CLI
<ul id="vivliostyle-cli-list"></ul>
### [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/index.md)
<ul>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/getting-started.md">Getting Started</a>
<ul id="vivliostyle-cli-getting-started-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/themes-and-css.md">Themes and CSS</a>
<ul id="vivliostyle-cli-themes-and-css-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/using-config-file.md">Using Config File</a>
<ul id="vivliostyle-cli-using-config-file-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/toc-page.md">Creating Table of Contents Page</a>
<ul id="vivliostyle-cli-toc-page-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/cover-page.md">Creating Cover Page</a>
<ul id="vivliostyle-cli-cover-page-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/special-output-settings.md">Special Output Settings</a>
<ul id="vivliostyle-cli-special-output-settings-list"></ul>
</li>
</ul>
{% 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)
<ul id="create-book-list"></ul>
{% include fetch-guide-url.html
id="create-book-list"
url="https://docs.vivliostyle.org/#/create-book"
get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/create-book.md"
%}

### Vivliostyle Themes
### [Vivliostyle Themes](https://vivliostyle.github.io/themes/#/)
<ul>
<li><a href="https://vivliostyle.github.io/themes/#/spec.md">Spec</a></li>
<li><a href="https://vivliostyle.github.io/themes/#/tutorial/step0.md">Development Tutorial</a></li>
<li><a href="https://vivliostyle.github.io/themes/#/official.md">Operational Guidelines</a></li>
</ul>

### Vivliostyle Flavored Markdown (VFM)
### [Vivliostyle Flavored Markdown (VFM)](https://vivliostyle.github.io/vfm/#/vfm)
<ul id="vfm-list"></ul>
{% 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
Expand All @@ -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 %}


Expand Down Expand Up @@ -110,6 +166,7 @@ Vivliostyle project discusses development matters on Slack.

guide=guide
reference=reference
contribution=contribution
plan=plan
community=community
%}
79 changes: 68 additions & 11 deletions ja/documents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,45 +9,98 @@ lang: ja
## 📖 ユーザーガイド
{% include fetch-guide-urls.html %}

### Vivliostyle Viewer
### [Vivliostyle Viewer](https://docs.vivliostyle.org/#/ja/vivliostyle-viewer)
<ul id="vivliostyle-viewer-list"></ul>
{% include fetch-guide-url.html
id="vivliostyle-viewer-list"
url="https://docs.vivliostyle.org/#/ja/vivliostyle-viewer"
get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/ja/vivliostyle-viewer.md"
%}

### Vivliostyle CLI
<ul id="vivliostyle-cli-list"></ul>
### [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/index.md)
<ul>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/getting-started.md">はじめに</a>
<ul id="vivliostyle-cli-getting-started-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/themes-and-css.md">テーマと CSS</a>
<ul id="vivliostyle-cli-themes-and-css-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/using-config-file.md">構成ファイル</a>
<ul id="vivliostyle-cli-using-config-file-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/toc-page.md">目次の作成</a>
<ul id="vivliostyle-cli-toc-page-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/cover-page.md">表紙ページの作成</a>
<ul id="vivliostyle-cli-cover-page-list"></ul>
</li>
<li>
<a href="https://github.com/vivliostyle/vivliostyle-cli/blob/main/docs/ja/special-output-settings.md">特別な出力設定</a>
<ul id="vivliostyle-cli-special-output-settings-list"></ul>
</li>
</ul>
{% 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)
<ul id="create-book-list"></ul>
{% include fetch-guide-url.html
id="create-book-list"
url="https://docs.vivliostyle.org/#/ja/create-book"
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/)
<ul>
<li><a href="https://vivliostyle.github.io/themes/#/ja/spec.md">仕様</a></li>
<li><a href="https://vivliostyle.github.io/themes/#/ja/tutorial/step0.md">開発チュートリアル</a></li>
<li><a href="https://vivliostyle.github.io/themes/#/ja/official.md">運用ガイドライン</a></li>
</ul>

### Vivliostyle Flavored Markdown (VFM)
### [Vivliostyle Flavored Markdown (VFM)](https://vivliostyle.github.io/vfm/#/ja/vfm)
<ul id="vfm-list"></ul>
{% 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
Expand All @@ -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 %}


Expand Down Expand Up @@ -111,6 +167,7 @@ Vivliostyle プロジェクトでは、開発方針などをSlack上で話し合

guide=guide
reference=reference
contribution=contribution
plan=plan
community=community
%}