Skip to content

docs(tutorials): update Japanese tutorials to CSS-first workflow and add English translations#171

Merged
ogwata merged 58 commits intomasterfrom
feature/ja-tutorials-cli-css-first
Apr 16, 2026
Merged

docs(tutorials): update Japanese tutorials to CSS-first workflow and add English translations#171
ogwata merged 58 commits intomasterfrom
feature/ja-tutorials-cli-css-first

Conversation

@ogwata
Copy link
Copy Markdown
Member

@ogwata ogwata commented Feb 27, 2026

Summary

  • Japanese tutorials (①–⑦) を Vivliostyle CLI v10 + CSS-first ワークフローに対応するよう更新
  • English translations of all tutorials (①–⑦) を新規追加
  • 日本語・英語両方のチュートリアル用スクリーンショットを全点撮り直し/新規撮影(日本語28枚、英語27枚)
  • ダウンロードアセットを plain CSS + ESM 形式に更新

Changes

Japanese tutorials

  • CLI v10 の実際の動作に合わせてコマンドやプロンプト手順を修正
  • SCSS → plain CSS、CJS → ESM に統一
  • スクリーンショットを Basic (Japanese) テンプレートで撮り直し

English tutorials

  • 全7チュートリアルの英語訳を追加(/tutorials/ 配下)
  • Basic テンプレートで英語版スクリーンショット27枚を新規撮影
  • 英語版では writing-mode(縦書き)セクションを削除
  • 英語固有の表現(Figure カウンター等)を反映

🤖 Generated with Claude Code

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

ja/tutorials を現行(2026年想定)の Vivliostyle CLI + CSS 前提の手順に更新し、旧 Create Book / SCSS 前提の説明やリンク不整合を整理するPRです。

Changes:

  • チュートリアル手順を Create Book から Vivliostyle CLI(npm create vivliostyle@latest)中心へ更新し、Node 要件も更新
  • SCSS 前提の説明・サンプルを CSS 表記へ置換し、CSS Custom Properties を使ったカスタマイズ例へ整理
  • 章間リンク、配布用ダウンロードパス、VFM ドキュメント参照リンクを最新系へ修正し、配布用 theme.css を追加

Reviewed changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
ja/tutorials/install.html Node 要件とエディタ案内を現行化
ja/tutorials/create-publications.html 雛形作成を Vivliostyle CLI(npm create vivliostyle@latest)前提へ更新
ja/tutorials/customize.html SCSS 前提の説明を削除し、CSS(Custom Properties)中心のカスタマイズ手順へ更新
ja/tutorials/configure-page-text.html SCSS 記述箇所・配布物参照を theme.css 前提へ更新
ja/tutorials/configure-counters-running-heads.html SCSS ネスト例を CSS セレクタへ変換、表記とリンク文言を更新
ja/tutorials/configure-basic-elements.html SCSS ネスト例を CSS セレクタへ変換、配布物参照を theme.css 前提へ更新
ja/tutorials/create-table-of-contents.html SCSS ネスト例を CSS セレクタへ変換、配布パスと前リンクを修正
assets/tutorials/ja/create-table-of-contents/manuscripts/honbun.md VFM ドキュメント参照リンクを docs.vivliostyle.org/ja 系へ更新
assets/tutorials/ja/configure-page-text/manuscripts/honbun.md VFM ドキュメント参照リンクを docs.vivliostyle.org/ja 系へ更新
assets/tutorials/ja/configure-page-text/theme.css 配布用 CSS を追加
assets/tutorials/ja/configure-counters-running-heads/theme.css 配布用 CSS を追加
assets/tutorials/ja/configure-basic-elements/theme.css 配布用 CSS を追加(※要修正点あり)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread assets/tutorials/ja/configure-basic-elements/theme.css
ogwata and others added 26 commits February 27, 2026 17:09
…ctual behavior

- create-publications: replace old interactive prompts (description/author-email/license/choose-theme)
  with actual v10 clack-style prompts (title/author/language/theme/install-deps)
- create-publications: remove duplicate bunko.md line in npm run build output
- customize: convert all vivliostyle.config.js examples from CommonJS to ESM
  (module.exports → import defineConfig / export default defineConfig)
- customize: fix theme install path themes/packages/@vivliostyle/ → node_modules/@vivliostyle/
- customize: update custom theme copy destination dir structure accordingly
- create-table-of-contents: convert config examples from CommonJS to ESM
…ial ②

Minimal template scaffolds an empty manuscript.md, not bunko.md.
Replace all references to bunko.md and 銀河鉄道の夜 sample content
with manuscript.md and a generic sample, including build output and
preview edit example.
Comprehensive review of create-publications.html against actual
CLI source code revealed 14+ issues including incorrect prompt
messages, wrong build output format, screenshot/text mismatch,
and tutorial quality concerns. This plan restores 銀河鉄道の夜
as sample content and fixes all terminal output examples.
… update TODO

- Tutorial ② (create-publications): add new build-cover/toc/body screenshots, update preview1/preview2
- Tutorial ④ (configure-page-text): retake all 9 screenshots (reset, margin, break-before, writing-mode, text-indent, text-align)
- Add TODO for updating legacy download assets (mytheme.zip with SCSS, CommonJS config)
- Update screenshots-todo.md checklist

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Retake preview-table-of-contents1.png (auto-generated TOC, horizontal writing)
- Retake preview-table-of-contents2.png (manual TOC with leader lines, horizontal writing)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- vivliostyle.config.js: convert CommonJS (module.exports) to ESM (import/export)
- mytheme.zip: replace SCSS files with plain CSS (theme_common.css only)
- Applies to tutorials ④ and ⑦

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ve writing-mode section

- Tutorial ②: add 5 English screenshots (build-cover/toc/body, preview1/preview2)
- Tutorial ④: add 8 English screenshots (reset, margin, break-before, text-indent, text-align)
- Tutorial ④: remove writing-mode section (not applicable for English)
- Add English manuscript files and download assets for tutorial ④

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ogwata and others added 17 commits April 15, 2026 17:48
…d tutorial7

- Heading Numbers: remove counter2/counter3, keep counter1 only
- Page Numbers: add CSS code example, move counter2 here, add target-counter() note pointing to tutorial7
- Counter References: remove section
- tutorial7: remove outdated article reference
- tutorial4 ja/en: remove outdated article reference in Page Start Side section
- tutorial5 ja: fix next-tutorial description (was describing tutorial5 itself)
- tutorial5 en: add Named strings / Running elements section to Running Head Style
- tutorial6 en: update Endnote Styles → Footnote Styles with dpub format
  - goal list, section title, description, config snippet, CSS selector (.footnotes → .footnote)
- tutorial7 ja: 後注 → 脚注, #footnotes → #footnote (dpub format)
- tutorial7 en: Endnotes → Footnotes, #footnotes → #footnote (dpub format)
- add goal list item for target-counter()
- add explanation paragraph before the CSS block describing target-counter(attr(href), page)
- ja: 目次の手動作成 → 目次の手動作成とカウンタの参照
- en: Manual Table of Contents → Manual creation of table of contents and reference to counters
- add goal list item for counter references
- Page Numbers: remove the sentence pointing to tutorial7 (moved to new section)
- add new section 'カウンタの参照' / 'Counter References' after Page Numbers
  - explain target-counter() with figure number example (CSS + Markdown)
  - add preview-counter3.png reference
  - close with note that tutorial7 uses target-counter() for page numbers in TOC
…ial5 (ja/en)

- ja: チュートリアル7 → チュートリアル⑦
- en: Tutorial 7 → Tutorial ⑦
- use '参照:[title(site name)](url)' format for ja
- use 'Reference: [title (site name)](url)' format for en
- tutorial3: Vivliostyle CLI docs → (docs.vivliostyle.org)
- tutorial4: libroworks.co.jp, Vivliostyle Blog annotated
- tutorial5: MDN Web Docs, W3C annotated
- tutorial7: Vivliostyle CLI docs → (docs.vivliostyle.org)
- This CSS example was added without user's explicit request
- Remove 'たとえば次のように...' sentence and h1::after code block
- preview-counter2.png target to be reconsidered
- # 後注 {#footnotes} → # 脚注 {#footnote}
- 後注はインライン → 脚注はインライン
… code examples

- Remove preview-counter2.png and preview-counter3.png (ja/en)
- Add target-counter() page number reference CSS + Markdown example to Page Numbers section (ja/en)
- Remove image references from Counter References section (ja/en)
…d dpub footnote format

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Download buttons in en tutorials 4-7 linked to files that did not exist.
Provide theme.css for each tutorial and manual-TOC config + manuscripts.zip
+ mytheme.zip for tutorial 7.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file was not referenced from any tutorial page.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ogwata
Copy link
Copy Markdown
Member Author

ogwata commented Apr 16, 2026

以下の修正をしました。ご確認ください。

レビューコメント対応

#1 「Vivliostyle Viewer で CSS 組版ちょっと入門」古記事参照の削除

  • 60d3b3b2be address MurakamiShinyu review (該当箇所の削除)

#2 「柱のスタイル」に Named strings / Running elements の紹介追加

  • 60d3b3b2be address MurakamiShinyu review (該当箇所の追記)

#3 「後注のスタイル」→ 「脚注のスタイル」(dpub 形式)

  • 60d3b3b2be address MurakamiShinyu review (セクション改名 + CSS 差替)
  • ae5f041b41 .footnotes.footnote セレクタ修正
  • 0458173c47 ja honbun.md 本文を dpub 形式に更新
  • d2e31b8d6e tutorial5/6 スクリーンショット差替(dpub脚注表示反映)

#4 「1.1章」→「§1.1」形式のスクリーンショット差替

  • 24b850d298 ja counter スクリーンショット撮り直し
  • 0ea826db63 en tutorial5/6/7 スクリーンショット撮り直し(§+dpub)

コメントとは無関係の修正

  • 936462a698 tutorial5 counter セクション再構成
  • d1ca840bfe en側を ja の再構成と同期
  • caa3f50e87 チュートリアル各ページの不整合修正
  • 6c98f34e17 tutorial7 に target-counter() 解説追加
  • 10f0ba5975 tutorial7 セクション見出しリネーム
  • 8dcf53a0c4 tutorial5 に「カウンタの参照」セクション追加
  • acea15b4b6 tutorial5 の参照表記を丸囲み数字に統一
  • 9925b3d7f9 外部参照リンクにサイト名追加
  • 52d556a35d en の libroworks.co.jp リンクは日本語タイトルのまま維持
  • 843649ca25 Page Numbers の h1::after CSS例を revert
  • 3b61e086c5 counter2/3 スクリーンショットを page-ref CSS コード例に差替
  • 786671bded en グローバルヘッダーに Tutorials リンク追加
  • 0ca7351dd4 en tutorial4-7 のダウンロードアセット追加(破損リンク修復)
  • 8b6f0a3a10 ja create-publications の孤児 build.png 削除

@ogwata ogwata requested a review from MurakamiShinyu April 16, 2026 06:19
Comment thread ja/tutorials/configure-basic-elements.html Outdated
@MurakamiShinyu
Copy link
Copy Markdown
Member

d2e31b8 tutorial5/6 スクリーンショット差替(dpub脚注表示反映)

日本語の assets/tutorials/ja/configure-basic-elements/preview-footnote1.png
assets/tutorials/ja/configure-basic-elements/preview-footnote2.png
の脚注が、pandoc形式のままのようです。英語の方は直ってます。

ogwata and others added 5 commits April 16, 2026 21:33
…k-reference description

Replace ja preview-*.png in configure-basic-elements with captures taken in
dpub footnote mode (matches en). Also correct the back-reference glyph
description: VFM dpub outputs the footnote number as superscript, not an
arrow.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…yles

The Footnote Styles section showed two image references that resolved to
the same dpub-mode capture, producing visually identical adjacent images.
Drop the second reference and the now-unused PNG in both ja and en.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Same situation as preview-footnote2: the second image reference resolved to
a duplicate of preview-figure1, with no caption distinguishing the two.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…/en)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@ogwata
Copy link
Copy Markdown
Member Author

ogwata commented Apr 16, 2026

@MurakamiShinyu ご指摘ありがとうございます。以下の修正を行いました。

ご指摘への対応

ja の preview-footnote1.png / preview-footnote2.png が pandoc形式のまま

  • 65eec31700 ja configure-basic-elements/preview-*.png 6枚を dpub 形式で撮り直し(en と同じ構成: ページ3単独 → headings/code/footnote、ページ4-5見開き → figure)

関連して見つかった問題への対応

戻りリンク記号の説明が実装と不一致

  • 「脚注のスタイル」セクションで `footnote-back` クラスの戻りリンクを `(⇘)` / `(↘)` と記載していましたが、VFM の dpub 実装は矢印ではなく「上付きの脚注番号」を出力します(`vfm/packages/vfm/src/plugins/footnotes.ts`)。
  • 65eec31700 説明文を `(上付きの脚注番号、例: ¹)` / `(superscript footnote number, e.g. ¹)` に修正(ja/en)

「脚注のスタイル」「画像のスタイル」セクションで同一画像が2枚並んでいた

  • `preview-footnote1.png` と `preview-footnote2.png`、および `preview-figure1.png` と `preview-figure2.png` がそれぞれ視覚的に同一でした(説明文にもキャプションなし)。
  • d5c47115cf `preview-footnote2.png` の参照と PNG を削除(ja/en)
  • 481ce8b344 `preview-figure2.png` の参照と PNG を削除(ja/en)

その他の修正

前提条件にCLIバージョン追記

  • ce6725079c / 7270add46c チュートリアル①の「前提条件 > 環境」に `Vivliostyle CLI v10.5 以上` を追加(ja/en)

Copy link
Copy Markdown
Member

@MurakamiShinyu MurakamiShinyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

だいたいよいと思います

@ogwata ogwata merged commit 9ab58f1 into master Apr 16, 2026
1 check passed
@ogwata ogwata deleted the feature/ja-tutorials-cli-css-first branch April 16, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants