https://github.com/hebilicious/nuxtpress

A nuxt module to use markdown files as pages
https://github.com/hebilicious/nuxtpress

content markdown nuxt nuxt3 static vitepress vue vue3

Last synced: 4 months ago
JSON representation

A nuxt module to use markdown files as pages

• Host: GitHub
• URL: https://github.com/hebilicious/nuxtpress
• Owner: Hebilicious
• License: mit
• Created: 2023-06-04T15:24:44.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2025-03-05T11:24:48.000Z (over 1 year ago)
• Last Synced: 2025-08-08T17:18:41.366Z (10 months ago)
• Topics: content, markdown, nuxt, nuxt3, static, vitepress, vue, vue3
• Language: TypeScript
• Homepage:
• Size: 307 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# ⚗️ Nuxtpress

[![CI](https://github.com/Hebilicious/authjs-nuxt/actions/workflows/ci.yaml/badge.svg)](https://github.com/Hebilicious/authjs-nuxt/actions/workflows/ci.yaml)

[![npm version](https://badge.fury.io/js/@hebilicious%2Fauthjs-nuxt.svg)](https://badge.fury.io/js/@hebilicious%2Fauthjs-nuxt)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

🚀 Welcome to __NuxtPress__!  

This is a Nuxt Module that allows you to use markdown as pages.

Under the hood, it uses `vite-plugin-vue-markdown` and all options are supported.

## ⚠️ Disclaimer

_🧪 This module is VERY WIP and is not recommended for production use. There will be breaking changes while I'm working on it._

## 📦 Installation

Use pnpm for development of your module :

```bash

pnpm i @hebilicious/nuxtpress

```

## 📦 Contributing

Contributions, issues and feature requests are welcome!

1. Fork this repo

2. Install `node` and `pnpm` _Use `corepack enable && corepack prepare pnpm@latest --activate` to install pnpm easily_

3. Use `pnpm i` at the mono-repo root.

4. Make modifications and follow conventional commits.

5. Open a PR 🚀🚀🚀