Extend Comark Docs

Set up a documentation site with the comark-docs Nuxt layer. Use when creating a docs app, installing the layer, extending nuxt.config, or wiring site name and URL.

comarkdown 3ad76e2 1005 B Updated

File contents

Extend comark-docs

Add the layer to a Nuxt app and point it at Markdown in content/.

Install

pnpm add comark-docs@github:comarkdown/comark-docs

Extend

export default defineNuxtConfig({
  extends: ['comark-docs'],
  site: {
    url: 'https://docs.example.com',
    name: 'My Project',
  },
})

Put Markdown in content/ (numeric-prefixed dirs for ordering, .navigation.yml per section) and run nuxt dev.

For branding (header, footer, wordmarks) see app.config.ts on the consuming site. GitHub repo, branch and content directory are inferred from git; override with NUXT_DOCS_* if needed.

Read more: Introduction, Installation, Configuration.

comarkdown/comark-docs/tree/main/playground/skills/extend-comark-docs commit 3ad76e24b6

Frequently asked questions

npx skillmds@latest add comarkdown/extend-comark-docs