Markdown

Nuxt Content uses the Markdown syntax and conventions to provide a rich-text editing experience.


  • Use Markdown to format your content with Prose components.
  • Edit the meta-data of your pages in the front-matter block of your files.

Prose

In Nuxt Content, Prose represents the HTML tags output from the Markdown syntax, for example title levels, links... A Vue component corresponds to each tag, allowing you to override them if needed.

Read the complete Prose reference in the API section

Example

Markdown
Just a paragraph.
Output
<p>Just a paragraph.</p>

Just a paragraph.

Customizing

If you want to customize a Prose component, here are the recommended steps:

  • Checkout the original component sources.
  • Use the exact same props.
  • Name it the same in your components/content/ directory.
  • Make it yours 🚀.

Front-matter

Front-matter is a convention of Markdown-based CMS to provide meta-data to pages, like description or title. In Nuxt Content, the front-matter uses the YAML syntax with key: value pairs.

These data are available when rendering the content and can hold any information that you would need.

Syntax

You can declare a front-matter block at the top of the Markdown files in the content/ directory with the --- identifier.

content/index.md
---title: 'Title of the page'description: 'meta description of the page'---<!-- Content of the page -->

Native parameters

KeyTypeDefaultDescription
titlestringFirst <h1> of the pageTitle of the page, will also be injected in metas
descriptionstringFirst <p> of the pageDescription of the page, will be shown below the title and injected into the metas
draftBooleanfalseMark the page as draft (and only display it in development mode).
navigationBooleantrueDefine if the page is included in fetchContentNavigation return value.
headObjecttrueEasy access to useContentHead

When used together with <ContentDoc> or the document-driven mode to display the current page, the useContentHead() composable will be used to set the page's metadata.

Code Highlighting

Code highlighting allows you to display beautiful code blocks in your website.

Nuxt Content uses Shiki, that colors tokens with VSCode themes.

Code highlighting works both on ProseCode and ProseCodeInline.