Skip to content
This repository has been archived by the owner on Apr 13, 2022. It is now read-only.
/ nuxt-articles Public archive

🔠 A simple Git-based headless CMS for small websites.

License

Notifications You must be signed in to change notification settings

dungsil/nuxt-articles

Repository files navigation

nuxt-articles

A simple Git-based headless CMS for small websites.

NPM npm (scoped)

Language
English | 한국어

Features

Generate an API endpoint with a markdown file you write in the articles directory.

TODO

  • Customizable remark, rehype plugins
  • Syntax highlighting to code blocks

Differences from @nuxt/content

  • Only support markdown
  • Provides only HTTP API
  • (Currently) Support Nuxt v3

Usages

npm install -D @dungsil/nuxt-articles
// nuxt.config.ts

export default {
  buildModules: ['@dungsil/nuxt-articles']
}
# .gitignore
server/api/articles.ts
  • Depending on the srcDir you may need to change it.

Contribute

nuxt-articles welcomes all contributions! 😍

Use case

License & Credit

MIT License © 2022 Kim Younggeon

Inspired by @nuxt/content, @nuxt/pwa
Reference by @unocss/nuxt