storyblok/nuxtdoc

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

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

• 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

nuxtdoc's Issues

Getting Started | Netlify Section | npm run generate command fails

I'm following the getting started guide (https://nuxtdoc.js.org/v1/guide/getting-started) and all is well up to the Netlify - 'npm run generate' section. This command fails. Below is my terminal output.

node: 8.11.1
npm: 5.6.0

Corresponding Storyblok Content

This is very useful, it would be great to include to the corresponding Storyblok Components and Content schemas etc...

Screen shots perhaps in the ReadMe file

Thx