https://github.com/janinawibker/docs
Documentation related things, very very early stage of development
https://github.com/janinawibker/docs
Last synced: 3 months ago
JSON representation
Documentation related things, very very early stage of development
- Host: GitHub
- URL: https://github.com/janinawibker/docs
- Owner: JaninaWibker
- License: mit
- Created: 2023-03-10T13:33:44.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-17T11:06:39.000Z (3 months ago)
- Last Synced: 2025-03-17T14:43:07.272Z (3 months ago)
- Language: TypeScript
- Homepage: https://janinawibker-docs.vercel.app
- Size: 491 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Docs
This is meant as a tool for quickly building a documentation site for your project.
This project is made up of 3 parts:
- [`app/`](/app): This is the boilerplate code you'll likely copy or recreate for your project. This is where you put your mdx files
- [`lib/`](/lib): Library with react components and a lot of utilities which can be used by `app/`
- [`mdx/`](/mdx): MDX plugins used by `app/`, mostly related to syntax highlighting
Both `lib/` and `mdx/` can be installed using npm, pnpm or yarn, you'll therefore not need the pnpm monorepo structure this repo has.
For development however this monorepo structure is benefitial to quickly iterate on features spanning multiple packages.
## Similar projects
- [nextra](https://nextra.site/)
- [mintlify](https://mintlify.com/docs/quickstart)
- [protocol](https://protocol.tailwindui.com)
- [docsify](https://docsify.js.org/)