Nuxtdoc
A setup to build beautiful documentation with Nuxt and Storyblok deployed on Netlify for everyone
Overview
NuxtDoc is a setup that allows users to build beautiful documentation with Nuxt and Storyblok, which can be deployed on Netlify. It provides a comprehensive solution for creating and managing documentation websites with a range of features.
Features
- Basic NuxtJS Setup
- Basic Startpage Setup
- Basic Responsive Styling
- Markdown content for Detail pages
- Generate Sidebar from Storyblok Content
- Generated Sidebar Subnavigation from Markdown
- Vuex Store for Sidebar Contents
- Storyblok Live Preview
- Doc Category Overview
- Doc Detail Page
- Deep Links
- Netlify Deployment
- Seed Components
- Seed Script
- Automatically optimize images
- Getting Started Guide
- Real Documentation as Example
- Add images to the real documentation
- Feature List
- Better Teaser Background Image
- Switch Header and Sidebar to default layout
- Actually use cached API Calls for Sidebar
- More general styles
- Fix Scrollbar issue on 800px - 1300px viewport
- Use variable in styles
- Add Multi Language Support
- Global Configuration in Storyblok for Header
- On Generate: Switch from Draft to Published content version
- Create getting started video
- Highlight JS
- More, more, more
Summary
NuxtDoc is a powerful tool for creating and managing documentation websites with ease. It provides a range of features, including responsive styling, sidebar generation, live preview, and deployment options. With NuxtDoc, users can create beautiful and interactive documentation sites in no time.
- Nuxt
nuxt.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- SCSS
SCSS is a preprocessor scripting language that extends the capabilities of CSS by adding features such as variables, nesting, and mixins. It allows developers to write more efficient and maintainable CSS code, and helps to streamline the development process by reducing repetition and increasing reusability.
- Storyblok
Storyblok is a headless CMS that provides a visual editor and flexible content modeling tools. This allows you to build dynamic, content-driven websites and applications without having to worry about the backend infrastructure.