search

vivliostyle / community

✍️ Ideas, Proposals, F2F Meeting
https://vivliostyle.org/community
GNU Affero General Public License v3.0
6 stars 0 forks source link

vivliostyle.org、docs.vivliostyle.orgにおけるVFMのドッグフィーディングの進め方 #93

Closed ogwata closed 2 years ago

ogwata commented 3 years ago

現在、vivliostyle.org は Jekyll を使い、docs.vivliostyle.org は Docute を使いMarkdownを処理しています。したがって、どちらのMarkdownもVFMとは違いがあります。

サイトを立ち上げたばかりの頃は仕方ありませんが、今の私達にはVivliostyle Flavored Markdown (VFM)があります。つい最近1.0をリリースしたこともあり、VFMの普及のためにも私達自身が積極的に使っていきたいところです。

vivliostyle.org、docs.vivliostyle.org におけるドッグフィーディングの進め方について討議したいと思います。皆さん、ぜひ知恵をお貸しください。

ogwata commented 3 years ago

現状、克服すべき課題をメモしておきます。

yamasy1549 commented 3 years ago

現在vivliostyle.orgはGitHub Pagesでビルドしており、そのおかげでローカル環境でビルドすることなくページを更新できています（たとえば、GitHub上でブログ記事を編集してそのまま投稿するなど）。

JekyllではカスタムMarkdownプロセスにより独自の記法をHTMLに変換することができます。この機能を使ってブログ記事などをVFMで書くことはできるはずですが、GitHub Pagesでビルドする際には使えないのでローカル環境でのビルドが必須になります。VFMをとるか、ローカル環境でのビルド不要をとるか、どちらかだと思います。

Vivliostyle.jsをCDNにして……という話が前にあったと思うのでそちらが使えるかもしれませんが、Jekyllとうまく併用できるかはちょっとわかりません。

akabekobeko commented 3 years ago

これを使えばいけるかもしれません。

GitHub Actions の workflow として VFM のビルドと actions-gh-pages 呼び出しによるデプロイを定義することになります。ビルドについては Static Site Generator 系のツールを単純化したようなプロジェクトを作成して実験するのがよさそうです。

akabekobeko commented 3 years ago

SSG 部分を参考にするなら GatsbyJS ですかね。私のブログはこれで構築して Netlify でホストしています。GatsbyJS を参考に最低限の機能を実装するとしたらこんな感じでしょうか。

もしくは GatsbyJS の gatsby-transformer-remark だけを VFM に置き換えられれば GatsbyJS の知見とエコシステムをそのまま利用できてよいですね。

ogwata commented 3 years ago

@akabekobeko

ありがとうございます。 よく分かってないのですが、GitHub Actions + GatsbyJS でVFMを使えそう、ということでよろしいでしょうか。 その場合、上記の「過去のコンテンツとの互換性確保が必要 」という部分はどういう実装になるのでしょう？

yamasy1549 commented 2 years ago

ref: https://github.com/vivliostyle/vivliostyle.org/issues/101

ogwata commented 2 years ago

vivliostyle/vivliostyle.org#101 が作成され、そちらで本Issueが参照されているので、クローズしましょう。