zhorton34 / contentwind

Content Wind

A lightweight Nuxt template to write a Markdown driven website, based on Nuxt Content, TailwindCSS and Iconify.

• Demo & Docs
• Play online

Features

• Document-Driven Mode
  • Create pages in Markdown in the content/ directory
  • Use Nuxt layouts in your Markdown pages
  • Enjoy meta tag generation from Markdown files
  • Generated navigation based on your pages
• Switch between Light & Dark mode 🌔
• Access 100,000 icons from 100+ icon sets with the <Icon> component
• Highlight code blocks with Shiki
• Create Vue components and use them in your Markdown
• Deploy on any Node or Static hosting: GH Pages, Vercel, Netlify, Heroku, etc.

Usage

Take a look at content-wind.nuxt.dev for the complete documentation.

Setup

Make sure to install the dependencies:

# yarn
yarn install

# npm
npm install

Development Server

Start the development server on http://localhost:3000

npm run dev

Deployment

Static Hosting

Pre-render the website to be deployed on any static hosting:

npm run generate

The dist/ directory is ready to be deployed (symlink to .output/public), learn more on Nuxt docs.

Node server

Build the application for production:

npm run build

Start the server in production:

node .output/server/index.mjs

Learn more on Nuxt docs for more information.