A guide to everything FOSS.
https://guide.bufoss.org
- MDX 44.2%
- TypeScript 38.1%
- Nix 17.7%
| .forgejo/workflows | ci: use lazy runners | |
| public | feat: use svg icon | |
| src | fix: the previous error with licenses of apps | |
| .editorconfig | init | |
| .envrc | init | |
| .gitattributes | init | |
| .gitignore | ci: add checks | |
| astro.config.ts | feat: use svg icon | |
| CONTRIBUTING.md | docs: add contributing | |
| deno.jsonc | ci: add checks | |
| deno.lock | fix: make the guide build again (and fmt) | |
| flake.lock | chore: prepare build for release | |
| flake.nix | chore: prepare build for release | |
| LICENSE | chore: prepare build for release | |
| README.md | docs: make readme cuter | |
[画像:buFOSS]
Guidebook
Built with Starlight Served by Grebedoc CC BY-SA 4.0
The buFOSS Guidebook is a collection of articles introducing Free and Open Source Software and concepts surrounding it, written by our community members.
🔧 Development
This project uses Deno v2 as its primary toolchain along with Astro.js for builds.
# Install dependencies.
deno install --allow-scripts
# Start the development server.
deno task dev
# Format the source tree, required!
deno fmt
🚀 Deployment
The guidebook is served on git-pages using the Forgejo Action here. If you wish to do it manually however, you can use the CLI instead.
Note
Node.js and npm are also required in the environment for Pagefind support, since Astro.js uses npx during the build phase.
# Build the site.
deno task build
# Preview the build.
deno task preview
# Serve the site.
git-pages-cli https://guide.bufoss.org \
--password "$PAGES_PASSWORD" \
--upload-dir ./dist