Entirely built in Typescript
Why use this over anything else?
It's just git cloning, then drag and dropping, and then changing a few lines of config code
and it's simple to change everything is either its own component or page,
I'm aiming to make the documentation source super easy to edit.
Already made for you, this is public anyone can use this which means
you don't have to make it yourself or use a different service thats heavier or more complex
You put your markdown docs in /md and it will auto load everything on it's own.
Then you'll want to change config.json which is in the same directory as this README.md.
You'll also want to delete all the examples cause this is also the entire website to our documentation.
This is how you'll start
git clone https://github.com/thepugmaker/CodexFlow.git
cd CodexFlow
npm installor you could
Download the source code to the latest stable build, That source code will be in releases on Github.
Like any other markdown!
Please check out react-markdown's way of creating markdown as their the library that runs this website.
or even use this README as a guide, As this is the main way I've tested.
- Logo
- Move on to next page in list
- Add date edited
- Search
- Mutiple Docs in one site
- Categories
This is not in order
- Fork react-markdown and add features to help CodexFlow (Fork Plans)
- Better config editing
- Everything can be changed in the one config.json
- Fix for mutiple devices
I plan to start the fork after I release the first version of this.
Fork plans are gonna be in their own ForkPlans.md
- empty
How to fix it
Run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun devor Run the production server:
npm run build
npm run start
# or
yarn build
yarn start
# or
pnpm build
pnpm start
# or
bun build
bun startI haven't tested yarn, pnpm, or bun at this point only npm