-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9d46c50
commit a6e9e3c
Showing
15 changed files
with
516 additions
and
165 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| layout: page | ||
| title: About Us | ||
| --- | ||
|
|
||
| {% capture foundation_description %} | ||
| Our purpose is to promote the development, | ||
| public release, | ||
| and adoption of the open source typesetting software Vivliostyle | ||
| which unifies the Web and publishing/printing world, | ||
| so that the typesetting technique that has been cultivated throughout the history of printing | ||
| is inherited and evolved on Web and digital publishing, | ||
| and contribute to digitization of publishing indispensable | ||
| for the advancement of academic, | ||
| literary and informational communication around the world and improve accessibility. | ||
| For this purpose, we carry out activities such as: | ||
|
|
||
| - Maintenance and management of Vivliostyle open source project and community | ||
| - Research and development of Vivliostyle and related technologies | ||
| - Promotion and education of Vivliostyle and CSS typesetting | ||
| - Promote standardization in cooperation with groups related to standard technologies such as Web, publishing, and accessibility | ||
| - Cooperation with external projects working with Vivliostyle | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture foundation_text %} | ||
| ### Vivliostyle Foundation | ||
|
|
||
| - Representative: Shinyu Murakami | ||
| - Founded: August 2018 | ||
| - Location: 1941-84 Daitakubo, Minami-ku, Saitama-shi, Saitama 336-0015, Japan | ||
| - Phone: +81-90-3688-2212 | ||
|
|
||
| ### Members | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture devteam_description %} | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% include page/about_us.html | ||
| foundation_title="About Vivliostyle Foundation" | ||
| foundation_description=foundation_description | ||
| foundation_text=foundation_text | ||
| foundation_members=site.data.foundation_members.en | ||
|
|
||
| devteam_title="Contributors" | ||
| devteam_description=devteam_description | ||
| slack_buttontext="Join our Slack" | ||
|
|
||
| sponsor_title="Be a Sponsor of Vivliostyle" | ||
| advertisement_buttontext="Advertise on this site" | ||
| advertisement_buttonlink="" | ||
| congrat_buttontext="Donate by credit card payment (to congrant)" | ||
| congrat_buttonlink="" | ||
| github_buttontext="Apply for the GitHub Sponsors" | ||
| github_buttonlink="" | ||
| %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| --- | ||
| layout: page | ||
| title: Documents | ||
| --- | ||
|
|
||
|
|
||
| {% capture guide_description %} | ||
| ### User Guide | ||
|
|
||
| - [User Guide](https://docs.vivliostyle.org/#/user-guide) | ||
| - [Introduction](https://docs.vivliostyle.org/#/user-guide#introduction) | ||
| - [Vivliostyle Viewer](https://docs.vivliostyle.org/#/user-guide#vivliostyle-viewer) | ||
| - [Supported document types](https://docs.vivliostyle.org/#/user-guide#supported-document-types) | ||
| - [Load document to render](https://docs.vivliostyle.org/#/user-guide#load-document-to-render) | ||
| - [Fine-grained config](https://docs.vivliostyle.org/#/user-guide#fine-grained-config) | ||
| - [Save and Print as PDF](https://docs.vivliostyle.org/#/user-guide#save-and-print-as-pdf) | ||
| - [Supported CSS features](https://docs.vivliostyle.org/#/user-guide#supported-css-features) | ||
| - [Contribution Guide]() | ||
|
|
||
| ### Contribution Guide | ||
|
|
||
| - [Contribution Guide](https://docs.vivliostyle.org/#/contribution-guide) | ||
| - [Module structure](https://docs.vivliostyle.org/#/contribution-guide#module-structure) | ||
| - [Setup a development environment](https://docs.vivliostyle.org/#/contribution-guide#setup-a-development-environment) | ||
| - [Build and serve](https://docs.vivliostyle.org/#/contribution-guide#build-and-serve) | ||
| - [Viewer and test files](https://docs.vivliostyle.org/#/contribution-guide#viewer-and-test-files) | ||
| - [Testing](https://docs.vivliostyle.org/#/contribution-guide#testing) | ||
| - [Building production version](https://docs.vivliostyle.org/#/contribution-guide#building-production-version) | ||
| - [Development mode](https://docs.vivliostyle.org/#/contribution-guide#development-mode) | ||
| - [Maintaining documents](https://docs.vivliostyle.org/#/contribution-guide#maintaining-documents) | ||
| - [Code](https://docs.vivliostyle.org/#/contribution-guide#code) | ||
| - [Other dev documents](https://docs.vivliostyle.org/#/contribution-guide#other-dev-documents) | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture reference_description %} | ||
| - [API Reference](https://docs.vivliostyle.org/#/api) | ||
| - [Supported Features](https://docs.vivliostyle.org/#/supported-features) | ||
| - [Available Properties](https://docs.vivliostyle.org/#/available-properties) | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_description %} | ||
| Would you like to contribute? | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_core_description %} | ||
| - Planning for the 2020 releases | ||
| - Version notation is vX.X.X format | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_pub_description %} | ||
| - [Features added]() | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_cli_description %} | ||
| - [PDF/X-1a compliant PDF file output]() | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_viewer_description %} | ||
| - [Update UI tests]() | ||
| - Multilingualization | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture plan_others_description %} | ||
| - Chrome Extension | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture license_description %} | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture community_description %} | ||
| Vivliostyle project discusses development matters on Slack. | ||
| {% endcapture %} | ||
|
|
||
| {% include page/documents.html | ||
| guide_title="Guide" | ||
| guide_description=guide_description | ||
|
|
||
| reference_title="Reference" | ||
| reference_description=reference_description | ||
|
|
||
| plan_title="Development Plan" | ||
| plan_description=plan_description | ||
| plans=plans | ||
|
|
||
| plan_core_title="Vivliostyle Core" | ||
| plan_core_url="" | ||
| plan_core_description=plan_core_description | ||
| plan_core_thumbnail="/assets/project-core.png" | ||
|
|
||
| plan_pub_title="Vivliostyle Pub" | ||
| plan_pub_url="" | ||
| plan_pub_description=plan_pub_description | ||
| plan_pub_thumbnail="/assets/project-pub.png" | ||
|
|
||
| plan_cli_title="Vivliostyle CLI" | ||
| plan_cli_url="" | ||
| plan_cli_description=plan_cli_description | ||
| plan_cli_thumbnail="/assets/project-cli.png" | ||
|
|
||
| plan_viewer_title="Vivliostyle Viewer" | ||
| plan_viewer_url="" | ||
| plan_viewer_description=plan_viewer_description | ||
| plan_viewer_thumbnail="/assets/project-viewer.png" | ||
|
|
||
| plan_others_title="Others" | ||
| plan_others_url="" | ||
| plan_others_description=plan_others_description | ||
|
|
||
| license_title="License" | ||
| license_description=license_description | ||
|
|
||
| community_title="Community invitation" | ||
| community_description=community_description | ||
| slack_buttontext="Join our Slack" | ||
| %} | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| layout: page | ||
| title: Getting Started | ||
| --- | ||
|
|
||
| {% capture pub_description %} | ||
| Edit text/Markdown/HTML in the left pane and preview the formatted results in the right pane. | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture cli_description %} | ||
| CSS typesetting on command line, and save as print-ready PDF/X-1a. | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture cli_frame1_description %} | ||
| Vivliostyle CLI will be released as an npm package. Also, Node.js must be installed. | ||
|
|
||
| ```shell | ||
| $ npm install -g @vivliostyle/cli | ||
| ``` | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture cli_frame2_description %} | ||
| In the Terminal command line, run it with your HTML file to output PDF file with CSS typesetting. There is also the preview option. | ||
|
|
||
| ```shell | ||
| $ vivliostyle preview | ||
| $ vivliostyle build | ||
| ``` | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture viewer_description %} | ||
| A typesetting engine that runs on the browser. Read HTML and display the formatted result on the browser. | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% capture viewer_frame1_description %} | ||
| Prepare HTML and CSS files and view the formatted result with Vivliostyle Viewer. This can be output as PDF. | ||
| {% endcapture %} | ||
|
|
||
|
|
||
| {% include page/getting_started.html | ||
| pub_title="Vivliostyle Pub <small>(Initial version will be released later this year)</small>" | ||
| pub_tip=site.data.project.pub.version | ||
| pub_description=pub_description | ||
| pub_buttontext="Use Vivliostyle Pub" | ||
| pub_buttonlink="" | ||
| pub_buttonlink_github="" | ||
|
|
||
| cli_title="Vivliostyle CLI <small>(To be released in February)</small>" | ||
| cli_tip=site.data.project.cli.version | ||
| cli_description=cli_description | ||
| cli_buttonlink_github=site.data.project.cli.github | ||
| cli_frame1_title="How to install" | ||
| cli_frame1_description=cli_frame1_description | ||
| cli_frame2_title="Create PDF from HTML" | ||
| cli_frame2_description=cli_frame2_description | ||
|
|
||
| viewer_title="Vivliostyle Viewer" | ||
| viewer_tip=site.data.project.viewer.version | ||
| viewer_description=viewer_description | ||
| viewer_buttontext="Use Vivliostyle Viewer" | ||
| viewer_buttonlink=site.data.project.viewer.sample | ||
| viewer_buttonlink_github=site.data.project.viewer.github | ||
| viewer_frame1_title="Want to make a book with CSS typesetting!" | ||
| viewer_frame1_description=viewer_frame1_description | ||
| viewer_gallery=site.data.pub.gallery.en | ||
| %} |
Oops, something went wrong.