Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Documentation site for Probitas - a scenario-based testing framework for Deno.
- 📖 Comprehensive documentation with markdown source
- 🔗 Auto-generated API reference from TypeScript source
- 🤖 LLM-friendly endpoints (/llms.txt, *.md)
- ⚡ Static site generation with Hono SSG
# Clone the repository
git clone https://github.com/probitas-test/documents.git
cd documents
# Start development server
deno task dev
# Open http://localhost:8000| Command | Description |
|---|---|
| deno task dev | Start dev server with watch mode |
| deno task start | Start production server |
| deno task build | Build static site to dist/ |
| deno task preview | Preview built site |
| deno task check | Type check all files |
| deno task test | Run tests |
| deno task verify | Run fmt, lint, check, and test |
| deno task generate-api | Regenerate API documentation JSON |
documents/ ├── main.ts # Entry point & Hono routes ├── deno.json # Project configuration ├── docs/ # Markdown documentation source ├── data/ │ ├── api/ # Generated API JSON (deno doc --json) │ ├── index/ # Example scenario index files │ └── docs.ts # Documentation pages configuration ├── templates/ # JSX page templates │ ├── api/ # API reference templates │ ├── docs/ # Documentation page templates │ ├── Layout.tsx # Main layout component │ ├── HomeLayout.tsx # Home page layout │ ├── components.tsx # Shared UI components │ ├── home.tsx # Home page template │ └── scripts.ts # Client-side JavaScript ├── lib/ # Utility modules │ ├── api-docs.ts # API documentation types & utilities │ ├── api-markdown.ts # API markdown generation │ ├── markdown.ts # Markdown processing │ ├── llms.ts # LLM-friendly endpoints │ ├── signature-formatters.ts # Type signature formatting │ └── type-references.ts # Type reference resolution ├── static/ # Static assets (CSS, images, favicon) ├── scripts/ # Build & generation scripts │ ├── build.ts # Static site generation & Pagefind indexing │ └── generate-api-docs.ts # API documentation fetching ├── tests/ # Integration tests └── probitas/ # Example Probitas scenarios
| Path | Format | Description |
|---|---|---|
| / | HTML | Landing page |
| /index.md | Markdown | Overview for LLMs |
| /llms.txt | Text | LLM site map |
| /docs/* | HTML | Documentation pages |
| /docs/*.md | Markdown | Raw markdown for LLMs |
| /api/ | HTML | API reference index |
| /api/{package}/ | HTML | Package API reference |
| /api/{package}/index.json | JSON | API data |
| /api/{package}/index.md | Markdown | API docs for LLMs |
- Deno 2.x or later
API documentation is generated from JSR packages using deno doc:
deno task generate-apiThis script:
- Fetches all @probitas/* packages from JSR API
- Runs deno doc --json for each package
- Processes and saves the output to data/api/
- Formats the generated JSON files
The generated files are then used by the build process to create API reference pages.
The deno task build command performs the following steps:
- Static Site Generation: Uses Hono's SSG to generate HTML, JSON, and Markdown files
- Asset Copying: Copies static assets (CSS, images, favicon) to dist/
- Search Indexing: Runs Pagefind to generate a search index
The build requires Pagefind to be installed. On macOS:
brew install pagefindFor other platforms, see Pagefind installation guide.
This site is deployed to GitHub Pages via GitHub Actions.
- Push to main branch
- GitHub Actions runs deno task build
- Static files in dist/ are deployed to GitHub Pages
Live site: https://probitas-test.github.io/documents
MIT © 2025 Alisue