Doxium

An easy solution to generate modern documentation in Next.js

Roadmap

Bold -> Important Italics -> Not sure

• Configure Next.js
• Configure Shadcn
• Write files
• (SSR) Link github (edit in gh button)
  • Convert to SSG somehow
• Colors
• Codeblock customisation
  • Shiki themes
  • Visibility
  • CopyButton
  • Languages (tsx, rs)
  • highlighting
• Fonts
• Fix codeblock bg bug
• Rename "Home Page" to use 'docs' folder.
• Fix turbo enabled by default (idk whyyyyyyyyyyyy)
• Clean up code
• Host schema not on github.
• Clean up console
• Stripping Github repo from config.
• dark/light theme seems hard and cringe
• Bug-fixing
• Use vertisan icons
• Move optional options to the bottom
• Remove bad looking colours (light themes)
• Make use of SSG and caching
• Make pages for folders (toggleable)??
• Make config file?
• Lib & Other aliases
• Move toaster to top if mobile
• Make TOC SSG
• Better errors in CLI
• Make code use alias
• Automate structure!
• Languages (en, ru)
• User-made themes -> marketplace? dk why tbh
• Custom Readme
• Add spinner (https://www.npmjs.com/package/cli-spinners) -> For different PM, diffferent spinner, dont want bun to use npm spinner?
• Mobile support
• Home page toggleable
  • Being able to toggle later on
• Accent color, shadcn color - differ them
• Make an API so owner can get data from docs
• https://www.npmjs.com/package/commander
  • Add better args and -y, etc..
• (half working) add decor dotted to everything
• https://shiki.matsu.io/packages/transformers
• Disable breadcrumb if page doesnt exist (just disabled everything)
• Fix spacing between lines in codeblock
• Add $Schema to config
• Custom checkboxes
• Make highlighter SSG idk
• Hover color accent -> base
• Add author to the end of page + last updated -> Actually really hard
• Check if emoji's parse
• Make Doxium Integratable (baseUrl)
• Add alias to the config for doxium components
• Fix fonts
• footer
• Windows support
• Table
• Tabs
• Timeline
• Filetree
• Add alerts (bookmark, warning, error, success, tip, accent, base)
• Package managers tabs
• Add link cards
• Add more stuff to sidebar
• Better search
• Fix "edit in github"
• Implement changing aliases
• Check differences between canary/15
• More shiki plugins and stuff
• Bunx doxium update
• toggleable folder/list in sidebar. if folder -> have pages (nice idea but hard)
• https://www.npmjs.com/package/picocolors?activeTab=readme
• https://www.npmjs.com/package/@vercel/ncc VERY GOOD -> use ncc build src/index.ts -o dist to build, dk how to link yet
• https://www.npmjs.com/package/fast-glob
• execa -> https://www.npmjs.com/package/cross-spawn
• Fix '(node:208623) [DEP0040] DeprecationWarning: The punycode module is deprecated. Please use a userland alternative instead. (Use node --trace-deprecation ... to show where the warning was created)' --> Issue with my node version, fixed by nvm install 20.5.1, nvm use 20.5.1

Deployment

• Website
• Setup npm & gh page
• Docs
• Logo

Techstack (Doxium)

• Next.js
• shadcn
• Tailwindcss
• MDX

Techstack (create-doxium-app)

• NCC

Author

Main developer, konyogony My tester and a friend who helped, PadowYT2, checkout his work!