carlosmoran092 / nuxtdoc

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

Home Page:https://nuxtdoc.js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

About

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

https://nuxtdoc.js.org

License:MIT License


Languages

Language:Vue 53.2%Language:JavaScript 42.0%Language:CSS 4.8%