Skip to content
A setup to build beautiful documentation with Nuxt and Storyblok deployed on Netlify for everyone
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
components
layouts
middleware
pages
plugins Adds nuxt v2 support Dec 7, 2018
static first commit Apr 3, 2018
store
.editorconfig
.eslintrc.js basic setup and layout Apr 3, 2018
.gitignore basic setup and layout Apr 3, 2018
.nvmrc
LICENSE
README.md
nuxt.config.js
package-lock.json
package.json Adds nuxt v2 support Dec 7, 2018
seed.components.json adds seed command Apr 9, 2018
seed.js
yarn.lock first commit Apr 3, 2018

README.md

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

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
You can’t perform that action at this time.