Skip to content
This repository was archived by the owner on Apr 13, 2022. It is now read-only.

dungsil/nuxt-articles

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

31 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

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

About

๐Ÿ”  A simple Git-based headless CMS for small websites.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks