Vivliostyle Documentation Site

This repository contains the source for the next-generation official documentation site for Vivliostyle.

Overview

• Static site generation with Astro + VFM (Vivliostyle Flavored Markdown)
• CSS supporting SSMO (Single Source Multi Output)
• Multilingual content (Japanese and English)
• Automated deployment with GitHub Actions (GitHub Pages)

Main Technologies

• Astro v5
• @vivliostyle/vfm (Markdown → HTML conversion)
• gray-matter (frontmatter parsing)

Directory Structure

/
├── content/           # Documentation content (Markdown)
│   ├── en/
│   └── ja/
├── public/            # Static assets served as-is
│   ├── styles/
│   ├── themes/
│   ├── vfm/
│   └── viewer/
├── src/               # Astro source (components, pages, styles, etc.)
│   ├── components/
│   ├── layouts/
│   ├── loaders/
│   ├── pages/
│   └── styles/
├── _investigation/    # Investigation notes and planning docs
├── packages/          # Local packages
├── submodules/        # Git submodules
├── .github/workflows/ # CI/CD workflows
├── astro.config.mjs
├── tsconfig.json
├── vivliostyle.config-*.js
└── package.json

Development, Build, and Deploy

Command	Description
npm install	Install dependencies
npm run dev	Start the dev server (http://localhost:4321)
npm run build	Build the static site into ./dist/
npm run preview	Preview the build output locally

Deployment is triggered automatically via GitHub Actions when you push to the astro-Install/main branch.

Published URL: https://docs.vivliostyle.org/

Contributing / References

• Vivliostyle Official Website
• Astro Documentation
• VFM (Vivliostyle Flavored Markdown)