NuxtDoc [WIP]

A setup to build beautiful documentation with Nuxt and Storyblok deployed on Netlify for everyone

Documentation and Getting Started

Full Documentation

Documentation: https://nuxtdoc.js.org

Getting Started

The Getting Started Guide: https://nuxtdoc.js.org/v1/guide/getting-started

Startpage

Features / Todo

• [x] Basic NuxtJS Setup
• [x] Basic Startpage Setup
• [x] Basic Responsive Styling
• [x] Markdown content for Detail pages
• [x] Generate Sidebar from Storyblok Content
• [x] Generated Sidebar Subnavigation from Markdown
• [x] Vuex Store for Sidebar Contents
• [x] Storyblok Live Preview
• [x] Doc Category Overview
• [x] Doc Detail Page
• [x] Deep Links
• [x] Netlify Deployment
• [x] Seed Components
• [x] Seed Script
• [x] Automatically optimize images
• [x] Getting Started Guide
• [x] Real Documentation as Example
• [x] Add images to the real documentation
• [x] Feature List
• [x] Better Teaser Background Image
• [x] Switch Header and Sidebar to default layout
• [x] Actually use cached API Calls for Sidebar
• [x] More general styles
• [x] Fix Scrollbar issue on 800px - 1300px viewport
• [x] Use variable in styles
• [ ] Add Multi Language Support
• [ ] Global Configuration in Storyblok for Header
• [x] On Generate: Switch from Draft to Published content version
• [ ] Create getting started video
• [ ] Highlight JS
• [ ] more more more