Conversation
- Update docs/ja/spec.md and docs/spec.md theme.css section - Replace SCSS mention with CSS custom properties recommendation - All theme packages already use plain CSS + CSS variables
- Add docs/ja/usage.md: Japanese theme usage reference - Add docs/usage.md: English theme usage reference - Add docs/ja/PLAN.md: development plan document - Cover: installation, configuration, CSS variable customization, official theme list, and theme-base module reference
- Expand docs/ja/development.md from empty stub to full reference - Add docs/development.md: English development reference - Cover: create-vivliostyle-theme CLI, file structure, theme.css editing, theme-base modules, CSS variable override, validation, publishing
- Add links to usage.md and development.md in README.md/index.md (ja/en) - Add CSS variable customization info and README links to gallery.md (ja/en) - Each official theme entry now notes CSS variable customization capability
There was a problem hiding this comment.
Pull request overview
This PR expands the docs/ documentation set by adding end-user and theme-authoring guides (EN/JA), updating the theme spec to reflect the current “CSS variables first” approach, and improving navigation between docs pages.
Changes:
- Add new “Using Themes” and “Developing Themes” guides in both English and Japanese.
- Update
spec.md(EN/JA) to recommend CSS custom properties instead of mentioning SCSS. - Update docs navigation/index pages and enrich the themes gallery entries with customization/README links.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/usage.md | New EN guide for installing, selecting, and customizing themes (incl. theme-base overview). |
| docs/ja/usage.md | New JA counterpart of the usage guide. |
| docs/development.md | New EN guide for scaffolding, customizing, validating, and publishing themes. |
| docs/ja/development.md | Expand existing JA development stub into a full guide. |
| docs/spec.md | Update theme.css spec text to recommend CSS variables (remove SCSS mention). |
| docs/ja/spec.md | Same spec update as EN version. |
| docs/index.md | Add links to the new usage/development guides. |
| docs/ja/index.md | Add links to the new usage/development guides (JA). |
| docs/gallery.md | Add notes that official themes support CSS-variable customization + README links. |
| docs/ja/gallery.md | Same gallery enrichment as EN version (JA). |
| docs/ja/PLAN.md | Add a JA development plan document describing phases and checklist. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
MurakamiShinyu
approved these changes
Apr 20, 2026
Member
MurakamiShinyu
left a comment
MurakamiShinyu
left a comment
There was a problem hiding this comment.
よさそうだと思います。あとは実際にこのドキュメントを見ながら使ってみた人からのフィードバックで改良するとよいと思います。
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
docs/のドキュメントを拡充し、テーマの使い方・作り方に関するガイドを追加しました。関連する開発計画:
docs/ja/PLAN.md変更内容
Phase 0: 既存ドキュメントの修正
docs/ja/spec.md,docs/spec.mdtheme.cssセクションの SCSS 言及を削除し、CSS カスタムプロパティの活用を推奨する記述に変更.scssファイルは存在せず、全テーマが CSS 変数ベースに移行済みのためPhase 1: テーマの使い方ガイド（新規）
docs/ja/usage.md（日本語版）/docs/usage.md（英語版）--vs-*）によるカスタマイズ方法と命名規則Phase 2: テーマの開発ガイド（拡充・新規）
docs/ja/development.md（空スタブを実体化）/docs/development.md（英語版・新規）create-vivliostyle-themeCLI の使い方と生成ファイル構成theme.cssの編集方法、theme-base モジュールの活用vivliostyle-theme-scripts validate/previewの使い方package.json必須フィールドと npm publish 手順Phase 3: 既存ページの整備
docs/ja/README.md,docs/ja/index.md,docs/README.md,docs/index.mdusage.mdとdevelopment.mdへのリンクを追加docs/ja/gallery.md,docs/gallery.md今後の予定
Phase 4 として、本 PR マージ後に
docs2.vivliostyle.org側で以下を実施予定:submodules/themesの参照を最新コミットに更新vivliostyle.config-themes-{ja,en}.jsにusage/developmentページのエントリを追加