No description
https://docs.awakenedredstone.com
- Vue 62.9%
- TypeScript 35.9%
- Nix 1.2%
|
|
||
|---|---|---|
| .forgejo/workflows | ||
| .vitepress | ||
| docs | ||
| patches | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .prettierrc | ||
| bun.lock | ||
| docs.json | ||
| eslint.config.ts | ||
| package.json | ||
| README.md | ||
| shell.nix | ||
| tsconfig.json | ||
| wrangler.toml | ||
docs-2
A place for all my documentations
This project requires bun to develop and deploy
It also has patches and modifications on top of VitePress
All docs must have an entry on docs.json
It is used to generate the side bar and top nav bar.
A doc must have a unique id as it's key and it's name, path (relative to docs) and initial versions provided.
versions should be updated using the script.
Setup:
bun install
Running:
Dev
bun run dev
The default port is 3000
Build
bun run build
The output will be at docs/.vitepress/dist
Creating a new version
bun ./.vitepress/newVersion.ts
Updating robots.txt
bun ./.vitepress/genRobotsTxt.ts
Updating robots.txt
bun ./.vitepress/genRobotsTxt.ts
Updating icons .ts files
bun ./.vitepress/generateIconsFile.ts
Making tailwind work with new pages
bun ./.vitepress/createOverlyLargeCssFile.ts