Doconuxt

Roadmap

Goals

  • Plug-and-play, zero-config solution for creating documentation in markdown
    • With possible option to eject and customise
  • Opinionated but as customisable as is needed
  • Comes with commonly used built-in components

Todos

Features

  • Mobile responsive design
  • Light/dark mode with Nuxt color mode
  • VuePress like directory structure and page routing behaviour for content/
  • User customisable Sidenav
  • User customisable Topnav
  • User customisable site metadata and settings
  • User customisable themes
  • Locale/language picker for i18n support

Built-in components

  • Custom alert blocks
  • Component showcase
  • Directory structure tree
  • Spoiler block
  • Badges
  • Panel block (for different code languages)
  • Search box

Future

  • User guide
  • Developer guide
  • Landing page
  • create-doconuxt-app package