https://github.com/konyogony/doxium
An easy solution to generate modern documentation in Next.js
https://github.com/konyogony/doxium
docs documentation doxium next nextjs shadcn tailwind typescript wiki
Last synced: about 2 months ago
JSON representation
An easy solution to generate modern documentation in Next.js
- Host: GitHub
- URL: https://github.com/konyogony/doxium
- Owner: konyogony
- Created: 2024-10-18T09:12:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-03-26T13:09:45.000Z (3 months ago)
- Last Synced: 2025-04-28T19:41:51.136Z (about 2 months ago)
- Topics: docs, documentation, doxium, next, nextjs, shadcn, tailwind, typescript, wiki
- Language: TypeScript
- Homepage: https://doxium.dev(wip)
- Size: 758 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Doxium
> Rewrite in progress! Some features may be raw or not work properly. Please create an issue if encountared. \
> **Beware, ALPHA version**
## Usage of `@doxium/cli` v0.0.8-alpha.1
Creating new app:
```sh
bunx @doxium/cli init [name] [...args]
```
Updating existing app:
```sh
bunx @doxium/cli update
```
Help:
```sh
bunx @doxium/cli --help
```
## Updated Roadmap
- [ ] Fix all the issues reported
- [ ] Add li8n support, should consider the nextjs way and custom way.
- [ ] Deploy to npmjs:
- [x] CLI
- [x] ~~Library w/ components~~ **Cancelled because of the complexity (Ive spent 3 weeks trying to do this to no avail)**
- [x] Make a command to upograde and migrate from one version to another. (This re-write will act as a base layer)
- [ ] Imporve search by making it go through all the text.
- [x] TailwindCSS v4
- [ ] Proper README
## Techstack (Doxium)
- [Next.js](https://nextjs.org/)
- [shadcn](https://ui.shadcn.com/)
- [Tailwindcss](https://tailwindcss.com/)
- [MDX](https://mdxjs.com/)
- [NCC](https://www.npmjs.com/package/@vercel/ncc)
## Credit
Lead developer - [konyogony](https://github.com/konyogony)
Beta Tester and a nice friend who helped - [PadowYT2](https://github.com/padowyt2)
Credits to [Next.js documentation](https://nextjs.org/docs) and [Nextra](https://nextra.site/docs) since I was influenced by them
[Doxium GitHub Repo](https://github.com/konyogony/Doxium)