vivliostyle / vivliostyle-sitegen Goto Github PK

View Code? Open in Web Editor NEW

2.0 2.0 0.0 65 KB

[WIP] Generate an static site from Markdown and resources by VFM (Vivliostyle Flavored Markdown).

License: Apache License 2.0

JavaScript 2.04% TypeScript 95.97% SCSS 1.99%

vivliostyle-sitegen's Introduction

Vivliostyle is an open source project for a new typesetting system based on web standard technology.

Vivliostyle.js offers HTML+CSS typesetting and rich paged viewing with EPUB/Web publications support.

🌏 Vivliostyle.org
📖 Documentation
🤝 Join Community
🕶 Awesome Vivliostyle
💅 Vivliostyle Themes

Packages
Contribution
- Bug Reports & Feature Requests
- Contributors ✨
Bronze Sponsor
License
Credits

Packages

`@vivliostyle/core`

A core library for HTML+CSS typesetting with EPUB/Web publications support.

See API Reference for further details.

`@vivliostyle/viewer`

A web app provides intuitive UI for Vivliostyle.

Use officially-hosted Vivliostyle Viewer or download a distribution package from https://vivliostyle.github.io.

`@vivliostyle/cli`

A command-line interface of Vivliostyle.

`@vivliostyle/react`

Use React component as a Vivliostyle renderer.

`@vivliostyle/vfm`

Vivliostyle Flavored Markdown (VFM) is a Markdown syntax optimized for book authoring. It is standardized and published for Vivliostyle and its sibling projects.

`@vivliostyle/print`

Vivliostyle Print allows page-layouting using Vivliostyle Core for printing within a website without destroying the original layout.

`create-book`

The fastest way to start writing book with Vivliostyle ecosystem.

`create-vivliostyle-theme`

Create Vivliostyle theme at ease.

Contribution

See Contribution Guide for development setup.
Development Wiki

Bug Reports & Feature Requests

Please report on GitHub Issues.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_sorotokin 💻	_{KAWAKUBO Toru} 💻	_{Satoru MATSUSHIMA (℠)} 💻	_{Seiya Konno} 💻	_{Johannes Wilm} 💻	_{Florian Rivoal} 💻	_{Satoshi KOJIMA} 💻
_{Masaya Yamauchi} 💻	_{Shinyu Murakami} 💻 📖 📢	_{Shota Kubota} 💻	_{spring-raining} 💻 📖 📢	_{Hiroshi Hatake} 💻	_takanakahiko 💻	_{Yasuaki Uechi} 💻 📖 🎨 📢
_{Zachary Waldowski} 💻	_yamasy1549 💻 🎨	_{OGATA Katsuhiro} 📝 📋	_akabeko 🖋 🤔	_youchan 💻 📢	_{Yuku Kotani} 💻	_{Christoph Päper} 💻
_{Ikko Eltociear Ashimine} 💻	_{Takai ayumu} 💻 📢	_{daisuke-tanabe} 💻	_{Hiroaki KAWAI} 💻	_{Enoch Gao} 💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Bronze Sponsor

Hatena Co., Ltd.

License

Licensed under AGPL Version 3.

Vivliostyle Core is implemented based on Peter Sorotokin's EPUB Adaptive Layout implementation, which is licensed under Apache License, Version 2.0.

Credits

vivliostyle-sitegen's People

Contributors

Stargazers

Watchers

vivliostyle-sitegen's Issues

ページ生成をコールバック関数でカスタマイズ可能とする

ページ生成をコールバック関数でカスタマイズ可能とする。Gatsby の Gatsby Node APIs のような機能を想定。

ユーザーはプロジェクトのルートに vivliostyle.sitegen-node.js を用意する
- ファイル名は一考の余地あり
- 既に設定ファイルとして vivliostyle.sitegen.js がある、これも -config.js にしたほうがよいかも
必要なコールバック関数を公開する
- できれば TypeScript にしたい、次点で ESM
- ダメなら CommonJS にするがそれでも exports.createPage のように名前付きとしたい
コールバック関数を検出したら通常のページ生成ではなく、そちらを呼びだす
- 設計的に HTML 生成とファイル書き出しを分離しておくとよさそう
- gatsby-node.js だと全ページのデータを渡しているようだが、メモリー使用量とか効率面の工夫があるのだろうか？
- タグやカテゴリーのページ生成をするにはメタデータだけも全ページ先行解析が必要
- ブログで前後記事のナビゲーションをリンクするのにも必要

サンプルを用意する

現在ひとつのサンプルを examples に用意しているが、用途別に複数提供したい。

simple
- なにもカスタマイズしていない状態のサンプル
blog
- ブログ用サンプル
- createPages によるカスタマイズあり
- Frontmatter の date により日時降順 (最新を先頭) でソートする
- Frontmatter の tags と categories からタグとカテゴリーのページを生成
- 最新記事 10 をトップとして生成
- ブログの前後記事リンクを生成

現行サンプルと同様に最初は npm publish してない開発用ソースを直に参照する。v1.0 以降で publish されたら、それを npm 参照するように修正予定。

ページ生成を再設計する

#2 対応を一通り終えたので watch による差分更新を再設計する。

現在は Markdown ファイルとして用意されているページのみ HTML 化している。しかしカテゴリーやタグなど Markdown のメタデータに基づく別ページも作成したい。

createPage で Markdown ファイルではなく Markdown テキストを指定する
- Content[] には Markdown テキストが既に指定されるので、これはそのまま処理可能
- カテゴリーやタグの場合、メタデータと EJS テンプレートだけで生成可能なので Markdown テキストは空文字でよい
createPage で public/ 上の HTML 出力パスを指定可能とする
- 現在の Content.htmlFilePath 相当
- Markdown ファイルと対応しないページについて Content を生成するか？それとも引数展開して Content 依存を解消するか？

ファイル更新時の差分ページ出力について。

createPages に更新情報を渡して Contents[] と共に差分処理をユーザーへ委ねるつもりだったが、これは面倒で負担が大きいため改善したい。GatsbyJS のようにユーザーは

createPages を実装して createPage 経由でページ生成をリクエストする
ファイル更新も含めた実際のページ出力は sitegen 側に委ねる

としたい。そのための方法として以下を検討。

Content[] と別にページ出力候補のデータを持つ
データは public/ 上に出力されるファイルを要素としたコレクションで Array または Object
- Array の場合、要素に識別子を持たせる、これは public/ 上のファイルパスでよさそう
- Object の場合、Key を識別子とする、これは public/ 上のファイルパスでよさそう
- パスの大文字と小文字を区別する OS 想定で lowercase にして区別しないことを強制する？
- GatsbyJS だとパスではなく ID を生成しているようだ
createPage からリクエストされたデータに対応する出力候補を検索、Object の diff を取る
- deep-object-diff を使うのが手軽でよさそう
- ファイルの削除で Content[] の数が増減した場合、ブログの前後記事リンク用メタデータが更新されるので対象と前後記事データについて diff 発生、差分更新されることが期待できる