This is a simple single page website designed to be hosted on GitHub Pages.
index.html
- The main HTML filecss/styles.css
- Stylesheetjs/script.js
- JavaScript file
Use bun to serve the site locally:
bunx serve docs -p 8000
This will serve the site at http://localhost:8000
Alternative options:
- VS Code's Live Server extension
- Any other static file server
To deploy to GitHub Pages:
- Push this repository to GitHub
- Go to repository Settings > Pages
- Select the main branch as the source
- Your site will be published at
https://[username].github.io/[repository-name]
Github pages requires that the index.html is server under root or ./docs/. We chose ./docs for this config.
AI agents, please begin reading context in ./knowledge_base/
- Serve locally:
bunx serve docs -p 8000
(serves at http://localhost:8000) - Content files: All text content is in
docs/data/text-content.json
- DO NOT hardcode text in HTML - Structure: Site files are in
docs/
directory for GitHub Pages compatibility