Skip to content

Repository files navigation

Front Matter - Documentation

This is the Front Matter its documentation respository.

Banner view of Front Matter, showing the extension with the a heading that reads "Headless CMD running in VS Code"

Main documentation

The documentation of the main Front Matter version can be found at frontmatter.codes.

BETA docs

The documentation of the BETA Front Matter version can be found at beta.frontmatter.codes.

Issues/Feedback

Please add issues or feedback of the Front Matter extension in the following repository: Front Matter repository.

Contributions

Contributions to the documentation are always welcome!

Tech stack

This site is built with Astro and Starlight.

Local development

npm install
npm run dev      # migrate docs + fetch changelog, then start the dev server
npm run build    # full production build
npm run preview  # preview the production build
npm run check    # type-check with astro check

How content is organised

  • Docs are authored in content/docs/** (same as before). On dev/build, scripts/migrate-docs.mjs copies them into the Starlight collection at src/content/docs/docs/**, placing each file at its slug so every /docs/<slug> URL and in-page #anchor is preserved. The generated collection and scripts/docs-manifest.json (which drives the sidebar) are git-ignored.
  • Changelog lives in content/changelog/**. CHANGELOG.md is fetched from the extension repo by scripts/copy-changelog.cjs and rendered at /updates; each v*.md release note is rendered at /updates/<version>.
  • Marketing pages (/, /community, /showcase, /swag, /analytics, 404) live in src/pages and share src/layouts/MarketingLayout.astro.
  • Custom markdown behaviour (legacy heading slugs, bold-blockquote callouts, code-fence titles, VS Code deep links) is implemented in src/plugins/** and wired in astro.config.mjs.
  • Config schemas under public/ are regenerated by scripts/generate-schema.cjs.

Sponsor this project

Used by

Contributors

Languages