Nuxt Content Template

An opionionated Nuxt.js Template with Nuxt Content!
View Demo »

Explore the docs · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

An extremely opinionated template for building Markdown oriented Nuxt websites with Nuxt Content and TailwindCSS. Focus on the development itself rather than all these low-level configuration stuffs.

Incentives:

• Wanted to build out my new personal website
• Want Markdown
• Want newest version of Vue, Nuxt and Nuxt Content.
• Buitl this multi-purpose template so I can use for other projects.

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

(back to top)

Built With

The technologies and tools used within this template.

• Vue
• Nuxt
• Nuxt Content
• TailwindCSS

(back to top)

Getting Started

Prerequisites

The list of tools that is used when development.

• npm

  npm install npm@latest -g

• Pnpm

  npm i -g pnpm

• Git

Installation

To run this template project in your local for personal use or contribution, simply perform the following.

1. Clone the repo

   git clone https://github.com/data-miner00/nuxt-content-template.git

2. Install Node dependencies

   pnpm i

3. Start the development server

   pnpm dev

⚠️ Important: Do not update the dependencies as it will break due to incompatibilities from the latest Nuxt and Nuxt Content.

(back to top)

Roadmap

• Add Dark Mode
• Add i18n
• Add Styling
  • Sass
  • Tailwind
• Add PWA Manifest
• Responsive styles
• DocSearch
• Copy code block button
• Add line numbers to code block
• Add highlight to code block
• Add missing items to mobile navbar

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

• Vue.js v3
• Nuxt v3
• Nuxt Content
• Robots.txt
• enji.dev
• How to Create a Custom Code Block With Nuxt Content v2
• VueUse
• @nuxtjs/color-mode
• Nuxt Tailwind
• How to add class attribute to the body tag in NuxtJs
• Nuxt i18n
• How to Build a Multi-Language Application with NuxtJS
• Vue i18n
• Nuxt Seo Kit
• Nuxt Image
• Nuxt UI

(back to top)