mirror of
https://github.com/Froststrap/docs.git
synced 2026-10-07 08:19:30 +00:00
Docs for Froststrap - WIP
- TypeScript 45.6%
- CSS 44.4%
- Nix 8.1%
- MDX 1.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| blog | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| docusaurus.config.ts | ||
| flake.lock | ||
| flake.nix | ||
| LICENSE.txt | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| sidebars.ts | ||
| tsconfig.json | ||
Website
This website is built using Docusaurus, a modern static website generator.
Installation
npm install
Note: feel free to use the package manager of your choice.
Local Development
npm run start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
npm run build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
USE_SSH=true npm run deploy
Not using SSH:
GIT_USER=<Your GitHub username> npm run deploy
If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.