shinGangan / nuxt-content

The file-based CMS for your Nuxt application, powered by Markdown and Vue components.

Home Page:https://content.nuxt.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nuxt-content-social-card

Nuxt Content

npm version npm downloads License Nuxt Volta

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.

Features

  • Nuxt 3 support
  • A Markdown syntax made for Vue components (MDC)
  • Navigation generation
  • Code highlighting with 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

Nuxt 2

Nuxt 2 is supported with Content v1, documentation is on https://content.nuxt.com/v1 and the code on the v1 branch.

๐Ÿ’ป Development

Note

This repository uses bash scripts for development and testing. If you are on Windows, you can use WSL or Git Bash.

  • 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 - Made with ๐Ÿ’š

About

The file-based CMS for your Nuxt application, powered by Markdown and Vue components.

https://content.nuxt.com

License:MIT License


Languages

Language:TypeScript 87.6%Language:Vue 11.9%Language:Shell 0.4%Language:JavaScript 0.1%