Skip to content

README.md

Latest commit

 

History

History
43 lines (30 loc) · 1.3 KB

README.md

File metadata and controls

43 lines (30 loc) · 1.3 KB
Raw

Inlay documentation

This public repository contains the Markdown source and static-site builder for the Inlay documentation.

Visit the published site at https://inlayphp.github.io/ once GitHub Pages has completed its first deployment.

The site opens on a product homepage with links to the guide, package references, the live demo, and the source repository. The full Markdown guide is available at /guide/index.html; package and project references live under /reference/.

Edit the documentation

The Markdown files are the source of truth. Update them in these locations:

  • docs/guide/ — the progressive user guide;
  • docs/ — project references;
  • packages/*/README.md — package API references.

CMS packages and Visual Editing are intentionally outside this core site.

Run locally

cd docs-site
npm install
npm run dev

Open http://localhost:4173. Build a production artifact with:

npm run build

The generated docs-site/dist/ directory is ignored by Git. GitHub Actions builds and deploys it automatically to GitHub Pages when the Markdown or site builder changes.

See CONTRIBUTING.md for the documentation workflow. Package and implementation changes belong in the main Inlay repository.