documents.md

layout	title
page	Documents

{% capture guide %}

📖 User Guides

{% include fetch-guide-urls.html %}

Vivliostyle Viewer

{% 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

• Getting Started
• Themes and CSS
• Using Config File
• Creating Table of Contents Page
• Creating Cover Page
• Special Output Settings

{% 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-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

{% 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

• Spec
• Operational Guidelines
  • Adoption of the Official Theme
  • Vivliostyle Themes Gallery

Vivliostyle Flavored Markdown (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

{% include fetch-guide-url.html id="contribution-guide-list" url="https://docs.vivliostyle.org/#/contribution-guide" get_url="https://api.github.com/repos/vivliostyle/docs.vivliostyle.org/contents/contribution-guide.md" %}

Vivliostyle CLI

• CONTRIBUTING.md

Vivliostyle Themes

• CONTRIBUTING.md

VFM

• CONTRIBUTING.md {% endcapture %}

{% capture reference %}

References

• Supported CSS Features
• Core API Reference
• Vivliostyle CLI API Reference
  • Config Reference
  • JavaScript API {% endcapture %}

{% capture plan %}

Development Plan

The following list is a summary of the hot issues for each project. Would you like to contribute?

• Vivliostyle.js
  • High priority issues
  • Good issues for first time contributors
• Vivliostyle CLI
  • Good issues for first time contributors
• VFM
  • Issues to release vfm v2.0.0
• Create Book
  • Issues to release create-book v1.0.0
• Themes
  • Good issue for first time contributors {% endcapture %}

{% capture community %}

{% include button/slack.html text="Join our Slack" %}

Vivliostyle project discusses development matters on Slack. {% endcapture %}

{% include page/documents.html title="Documents" lead="We have arranged a variety of documents that developers can rely on when in trouble. In “Development Plan”, each item links to the corresponding GitHub issue."

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