An opionionated Nuxt.js Template with Nuxt Content!
View Demo »
Explore the docs
·
Report Bug
·
Request Feature
An extremely opinionated template for building Markdown oriented Nuxt websites with Nuxt Content and TailwindCSS. Focus on the development itself rather than low-level configurations.
Incentives:
Projects that use this template:
The technologies and tools used within this template.
The version for Nuxt (3.6.1) and Nuxt Content (2.7.0) must remain. Updating the version for these two packages will break the static site generation. Regardless, the existing version in my humble opinion is good enough to create a functional documentation/blogs.
This template currently offers the following features. For more info, please read the guide.
rehype-mathjax
, remark-math
)
@nuxtjs/i18n
)@nuxtjs/color-mode
)nuxt-seo-kit
)
@nuxt/image
)@vueuse/core
)@vueuse/motion
)Again, if you wish to grok what this template is capable of, consider visiting my technical blog to see it for yourself.
The list of tools that is used when development.
npm install npm@latest -g
npm i -g pnpm
To run this template project in your local for personal use or contribution, simply perform the following.
git clone https://github.com/data-miner00/nuxt-content-template.git
pnpm i
pnpm dev
⚠️ Important: Do not update the dependencies as it will break due to incompatibilities from the latest Nuxt and Nuxt Content.
See the open issues for a full list of proposed features (and known issues).
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!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the MIT License. See LICENSE
for more information.
List of resources that are helpful and would like to give credit to.