https://github.com/storyblok/nuxtdoc
A setup to build beautiful documentation with Nuxt and Storyblok deployed on Netlify for everyone
https://github.com/storyblok/nuxtdoc
nuxt storyblok
Last synced: 6 months ago
JSON representation
A setup to build beautiful documentation with Nuxt and Storyblok deployed on Netlify for everyone
- Host: GitHub
- URL: https://github.com/storyblok/nuxtdoc
- Owner: storyblok
- License: mit
- Archived: true
- Created: 2018-04-09T11:05:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-12-07T11:01:48.000Z (almost 7 years ago)
- Last Synced: 2024-11-01T05:32:55.043Z (11 months ago)
- Topics: nuxt, storyblok
- Language: Vue
- Homepage: https://nuxtdoc.js.org
- Size: 343 KB
- Stars: 104
- Watchers: 6
- Forks: 43
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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