65 lines
2.8 KiB
Markdown
65 lines
2.8 KiB
Markdown
[](https://content.nuxt.com)
|
|
|
|
# Nuxt Content
|
|
|
|
[![npm version][npm-version-src]][npm-version-href]
|
|
[![npm downloads][npm-downloads-src]][npm-downloads-href]
|
|
[![License][license-src]][license-href]
|
|
[![Nuxt][nuxt-src]][nuxt-href]
|
|
[![Volta][volta-src]][volta-href]
|
|
|
|
Nuxt Content reads the `content/` directory in your project, parses `.md`, `.yml`, `.csv` or `.json` files and creates a powerful data layer for your application. Bonus, use Vue components in Markdown with the [MDC syntax](https://content.nuxt.com/usage/markdown).
|
|
|
|
- [📖 Read the documentation](https://content.nuxt.com)
|
|
- [👾 Playground](https://stackblitz.com/github/nuxt/content/tree/main/examples/essentials/hello-world?file=app.vue)
|
|
- [✨ Intro video](https://www.youtube.com/watch?v=o9e12WbKrd8)
|
|
- [✍️ Nuxt Studio](https://nuxt.studio)
|
|
|
|
## Features
|
|
|
|
- [**Nuxt 3**](https://nuxt.com) support
|
|
- A Markdown syntax made for Vue components ([**MDC**](https://content.nuxt.com/usage/markdown))
|
|
- Navigation generation
|
|
- Code highlighting with [**Shiki**](https://github.com/shikijs/shiki)
|
|
- Blazing fast hot module replacement in development
|
|
- Powerful query builder (MongoDB like)
|
|
- Table of contents generation
|
|
- Also handles CSV, YAML and JSON(5)
|
|
- Extend with hooks and content plugins
|
|
- [... and more](https://content.nuxt.com)
|
|
|
|
## Nuxt 2
|
|
|
|
Nuxt 2 is supported with Content v1, documentation is on <https://content.nuxt.com/v1> and the code on the [v1](https://github.com/nuxt/content/tree/v1) branch.
|
|
|
|
## 💻 Development
|
|
|
|
> [!NOTE]
|
|
> This repository uses bash scripts for development and testing. If you are on Windows, you can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) or [Git Bash](https://gitforwindows.org/).
|
|
|
|
- Clone repository
|
|
- Install dependencies using `pnpm install`
|
|
- Prepare using `pnpm prepare`
|
|
- Build using `pnpm build`
|
|
- Try playground using `pnpm dev`
|
|
- Test using `pnpm test`
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE) - Made with 💚
|
|
|
|
[npm-version-src]: https://img.shields.io/npm/v/@nuxt/content/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-version-href]: https://npmjs.com/package/@nuxt/content
|
|
|
|
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[npm-downloads-href]: https://npm.chart.dev/@nuxt/content
|
|
|
|
[license-src]: https://img.shields.io/github/license/nuxt/content.svg?style=flat&colorA=18181B&colorB=28CF8D
|
|
[license-href]: https://github.com/nuxt/content/blob/main/LICENSE
|
|
|
|
[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
|
|
[nuxt-href]: https://nuxt.com
|
|
|
|
[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
|
|
[volta-href]: https://volta.net/nuxt/content?utm_source=readme_nuxt_content
|