Giter Site home page Giter Site logo

j05hi / nuxtdoc Goto Github PK

View Code? Open in Web Editor NEW

This project forked from storyblok/nuxtdoc

0.0 0.0 0.0 476 KB

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

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

License: MIT License

JavaScript 42.03% Vue 53.17% CSS 4.80%

nuxtdoc's Introduction

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

nuxtdoc's People

Contributors

dominikangerer avatar j05hi avatar onefriendaday avatar sinchang avatar suits-at avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.