mirror of
https://github.com/nuxt/nuxt.git
synced 2024-11-24 22:55:13 +00:00
3ec108493d
* docs: simplify docs to only markdown * Create nuxt-config.md * chore: update * chore: add readme
1.8 KiB
1.8 KiB
navigation.icon | title | head.title | description |
---|---|---|---|
IconDirectory | content | content/ | The Content module reads the content/ directory to create a file-based CMS for your application. |
Content Directory
The Nuxt Content module reads the content/
directory in your project and parses .md
, .yml
, .csv
and .json
files to create a file-based CMS for your application.
::list{type=success}
- Render your content with built-in components.
- Query your content with a MongoDB-like API.
- Use your Vue components in Markdown files with the MDC syntax.
- Automatically generate your navigation.
::
Get Started
Installation
Install the @nuxt/content
module in your project:
::code-group
yarn add --dev @nuxt/content
npm install --save-dev @nuxt/content
pnpm add -D @nuxt/content
::
Then, add @nuxt/content
to the modules
section of nuxt.config.ts
:
export default defineNuxtConfig({
modules: [
'@nuxt/content'
],
content: {
// https://content.nuxtjs.org/api/configuration
}
})
Create Content
Place your markdown files inside the content/
directory in the root directory of your project:
# Hello Content
The module automatically loads and parses them.
Render Pages
To render content pages, add a catch-all route using the ContentDoc
component:
<template>
<main>
<ContentDoc />
</main>
</template>
Documentation
::alert{type=info} Head over to https://content.nuxtjs.org to learn more about the Content module features, such as how to build queries and use Vue components in your Markdown files with the MDC syntax. ::