selfdoc 0.3.1__tar.gz

selfdoc-0.3.1/.claude/settings.json

@@ -0,0 +1,3 @@
+{
+  "hooks": {}
+}

selfdoc-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22, 24]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: node -e "require('./package.json')"
+      - run: npm test --if-present
+      - run: npm audit --audit-level=moderate || true

selfdoc-0.3.1/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

selfdoc-0.3.1/.gitignore

@@ -0,0 +1,34 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+dist/
+build/
+*.egg
+.venv/
+venv/
+.eggs/
+
+# Node
+node_modules/
+npm-debug.log*
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Docs build output
+docs/_build/
+
+# Wrangler
+.wrangler/
+
+# rlsbl
+.rlsbl/lock

selfdoc-0.3.1/.rlsbl/bases/.claude/settings.json

@@ -0,0 +1,3 @@
+{
+  "hooks": {}
+}

selfdoc-0.3.1/.rlsbl/bases/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20, 22, 24]
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: node -e "require('./package.json')"
+      - run: npm test --if-present
+      - run: npm audit --audit-level=moderate || true

selfdoc-0.3.1/.rlsbl/bases/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          registry-url: https://registry.npmjs.org
+      - run: npm publish --provenance --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  pypi:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: astral-sh/setup-uv@v7
+      - run: uv build
+      - uses: pypa/gh-action-pypi-publish@release/v1

selfdoc-0.3.1/.rlsbl/bases/.gitignore

@@ -0,0 +1,14 @@
+node_modules/
+__pycache__/
+*.pyc
+*.log
+.DS_Store
+coverage/
+dist/
+*.egg-info/
+.rlsbl-notes-*.tmp
+.credentials.json
+.*-cache.json
+.env
+.env.local
+*.local-only

selfdoc-0.3.1/.rlsbl/bases/.rlsbl/hooks/post-release.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# Post-release hook. Runs after a successful release (non-fatal).
+# Environment: RLSBL_VERSION is set to the released version.
+# Customize this for your project (e.g., local install, deploy, notify).
+
+set -euo pipefail
+
+echo "Post-release: v$RLSBL_VERSION"

selfdoc-0.3.1/.rlsbl/bases/.rlsbl/hooks/pre-release.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+# Pre-release validation hook.
+# Runs before rlsbl creates a release. Exit non-zero to abort.
+# Detects project type and runs appropriate checks automatically.
+
+set -euo pipefail
+
+echo "Running pre-release checks..."
+
+if [ -f go.mod ]; then
+  echo "  Go: vet + build + test"
+  go vet ./...
+  go build ./...
+  go test ./... -race -short -count=1
+fi
+
+if [ -f pyproject.toml ]; then
+  echo "  Python: pytest"
+  if command -v uv &>/dev/null; then
+    uv run pytest
+  elif command -v pytest &>/dev/null; then
+    pytest
+  fi
+fi
+
+if [ -f package.json ] && node -e "process.exit(require('./package.json').scripts?.test ? 0 : 1)" 2>/dev/null; then
+  echo "  npm: test"
+  npm test
+fi
+
+echo "Pre-release checks passed."

selfdoc-0.3.1/.rlsbl/bases/CLAUDE.md

@@ -0,0 +1,20 @@
+# selfdoc
+
+## Release workflow
+
+This project uses [rlsbl](https://github.com/smm-h/rlsbl) for release orchestration.
+
+- Update CHANGELOG.md with a `## X.Y.Z` entry describing changes
+- Run `rlsbl release [patch|minor|major]` to bump version and create a GitHub Release
+- CI handles publishing automatically via the publish workflow
+- Never publish manually — always use `rlsbl release`
+- Requires NPM_TOKEN secret on GitHub (Settings > Secrets > Actions)
+- Use `rlsbl release --dry-run` to preview a release without making changes
+
+## Conventions
+
+- No tokens or secrets in command-line arguments (use env vars or config files)
+- All file writes to shared state should be atomic (write to tmp, then rename)
+- External calls (APIs, CLI tools) must have timeouts and graceful fallbacks
+- Use `npm link` (npm) or `uv pip install -e .` (Python) for local development
+- CI runs smoke tests on every push; manual testing for UI/UX changes

selfdoc-0.3.1/.rlsbl/hashes.json

@@ -0,0 +1,8 @@
+{
+  ".github/workflows/ci.yml": "83903a715b1d07683962b041e8f56727440e239070eb055995b5f6c863dfa813",
+  ".github/workflows/publish.yml": "ff275580a98127104d28ce4a9b2992ce6a30a5d96de9bfcaa1b95bee97e5e2da",
+  "CLAUDE.md": "10cacc0e23da91fa5d18765bea4c1195cc3cfcbf9725bae882bdd84f545a12d0",
+  ".rlsbl/hooks/pre-release.sh": "9bae4134d0a4c302287766f9a4a2923b6c5706d2cc7078f553fec843b8cd5a06",
+  ".rlsbl/hooks/post-release.sh": "b455f8511e0b2655509ecf5dcb0ab7da5bb7c961f47910ff8e00cab5bd51f833",
+  ".claude/settings.json": "78922a784ee78e9e50587e93628cd3b9d4dfbe49087adc4514e6781cea38cbb9"
+}

selfdoc-0.3.1/.rlsbl/hooks/post-release.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+# Post-release hook. Runs after a successful release (non-fatal).
+# Environment: RLSBL_VERSION is set to the released version.
+# Customize this for your project (e.g., local install, deploy, notify).
+
+set -euo pipefail
+
+echo "Post-release: v$RLSBL_VERSION"
+
+if command -v selfdoc &>/dev/null && [ -f selfdoc.json ]; then
+  [ -f ~/Projects/.env ] && set -a && source ~/Projects/.env && set +a
+  echo "Building and deploying docs..."
+  selfdoc build && selfdoc deploy
+fi

selfdoc-0.3.1/.rlsbl/hooks/pre-release.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+# Pre-release validation hook.
+# Runs before rlsbl creates a release. Exit non-zero to abort.
+# Detects project type and runs appropriate checks automatically.
+
+set -euo pipefail
+
+echo "Running pre-release checks..."
+
+if [ -f go.mod ]; then
+  echo "  Go: vet + build + test"
+  go vet ./...
+  go build ./...
+  go test ./... -race -short -count=1
+fi
+
+if [ -f pyproject.toml ]; then
+  echo "  Python: pytest"
+  if command -v uv &>/dev/null; then
+    uv run pytest
+  elif command -v pytest &>/dev/null; then
+    pytest
+  fi
+fi
+
+if [ -f package.json ] && node -e "process.exit(require('./package.json').scripts?.test ? 0 : 1)" 2>/dev/null; then
+  echo "  npm: test"
+  npm test
+fi
+
+echo "Pre-release checks passed."

selfdoc-0.3.1/.rlsbl/version

@@ -0,0 +1 @@
+0.21.2

selfdoc-0.3.1/CHANGELOG.md

@@ -0,0 +1,103 @@
+# Changelog
+
+## 0.3.1
+
+- npm package renamed from `selfdoc` to `selfdocumenting` (npm blocks `selfdoc` due to similarity with abandoned `self-doc` package). Install via `npm install -g selfdocumenting` or `npx selfdocumenting`. The CLI command remains `selfdoc`.
+
+## 0.3.0
+
+### Breaking Changes
+
+- `base_url` is now a required field in `selfdoc.json` (previously optional)
+- Frontmatter `description` is now required on every page (auto-extraction removed); missing description is a build error
+- `selfdoc build` now fails on SEO lint warnings
+
+### Added
+
+- Subdirectory-based nested nav groups with collapsible sidebar sections, localStorage persistence, and frontmatter overrides (`nav_group`, `nav_order`)
+- Configurable search trigger via `search` config field: `"icon"` (magnifying glass button), `"bar"` (text input with Cmd+K hint), or `"hidden"`
+- Functional feedback widget via `feedback` config field with webhook POST and Google Analytics event support
+- Atom feed generation (`feed.xml`) with auto-discovery `<link>` tag in `<head>`
+- Definition list syntax (`term\n: definition`) with glossary styling and DefinedTerm JSON-LD
+- Inline stat markup (`==value==`) producing semantic `<data>` elements
+- Code tabs for switching between language variants with localStorage persistence
+- Git branch auto-detection for edit links; configurable via `branch` config field
+- Edit link shown at both top and bottom of content area
+- Rich OG card PNG generation with text overlay via predraw (optional dependency)
+- SEO lint framework with 15 rules covering headings, descriptions, images, contrast, and structured data
+- JSON-LD structured data: TechArticle, BreadcrumbList, WebSite, SoftwareSourceCode, Organization/Person, ItemList, DefinedTermSet
+- Open Graph and Twitter Card meta tags with `og:locale`, `og:image:alt`, and auto-generated social card images
+- `robots.txt` with explicit AI crawler permissions (GPTBot, ClaudeBot, PerplexityBot, etc.)
+- `llms.txt` and `llms-full.txt` for AI documentation ingestion
+- Visible "Last updated" dates with `<time>` elements, `dateModified` in JSON-LD, and sitemap `lastmod`
+- `selfdoc check --ignore SEO007,SEO008` to suppress specific lint rules
+- `selfdoc check --format json` for machine-readable output
+- `selfdoc check` reports undocumented public symbols when coverage is below 100%
+- Color-coded `selfdoc check` output (green/yellow/red by severity)
+- `lint_ignore` config field for project-level lint rule suppression
+- New config fields: `lang` (BCP 47), `author`, `twitter`, `branch`, `search`, `feedback`
+
+### Fixed
+
+- Edit link and "Last updated" date no longer run together (flex layout with gap)
+- Sticky table headers no longer hide behind the fixed topbar
+- Search shows "No results" message instead of blank space
+- Search dialog closes when clicking a result link
+- Copy button now always visible on code blocks (was hidden until hover, invisible on touch)
+- Fixed dark mode contrast for all accent colors
+- Fixed breadcrumb intermediate links pointing to non-existent directory index pages
+- Fixed code-block hover shadow invisible in dark mode
+
+### Improved
+
+- Build-time Pygments syntax highlighting (replaced client-side highlight.js)
+- Build-time CSS, JS, and HTML minification with critical CSS inlining
+- Gzip and Brotli pre-compression of build output
+- Search JS externalized to `search.js` with lazy index loading
+- Conditional JS inclusion based on page content
+- ARIA labels on sidebar nav, TOC nav, and search dialog
+- Dynamic theme toggle ARIA label indicating current state
+- Roving tabindex on code tabs per WAI-ARIA pattern
+- Table `<caption>` derived from preceding heading for screen readers
+- 44px minimum touch targets on all interactive elements
+- Heading anchors visible on touch devices
+- Admonition icons (distinct SVG per type: info, lightbulb, warning triangle, octagon, exclamation)
+- Card-style prev/next navigation links
+- Styled generic `<details>/<summary>` in content
+- Styled standalone `<dfn>` tags outside glossary context
+- RSS feed link in site footer
+- Fragment highlight animation when navigating to `#section` URLs
+- Print stylesheet: 2cm margins, forced light colors, hidden breadcrumbs, code wrapping
+- Topbar truncates long project names with ellipsis
+- Security headers and trailing slash redirects for Cloudflare Pages
+
+## 0.2.0
+
+### Added
+
+- Theme system with per-project theming via `"theme"` in selfdoc.json and optional `docs/custom.css` overrides
+- Minimal theme: clean typography, dark mode, high-contrast, and reduced-motion variants (all auto-detected from OS preferences)
+- Top bar with project name and version badge
+- Heading anchor links for deep linking
+- Syntax highlighting via highlight.js (light + dark themes)
+- Google-style docstring formatting (Args, Returns, Raises rendered as structured lists)
+
+### Fixed
+
+- Heading hierarchy: directive expansions use h2/h3/h4 instead of injecting h1
+- Module name mangling (`selfdoc.extractorsthon` bug)
+- Nested `_build/_build` recursion when rebuilding
+- Deploy supports `CF_ACCOUNT_ID` and `CF_PAGES_API_TOKEN` env var names (remapped to wrangler's expected names)
+- CSS extracted to cacheable `style.css` instead of inlined per page
+
+## 0.1.0
+
+- Code-aware static site generator
+- `:::directive` syntax for embedding code-extracted content
+- Python, Go, TypeScript/JS extractors
+- 5 built-in directives (module, schema, test, cli, config)
+- Custom directive plugins
+- `selfdoc check` coverage analysis
+- HTML generation with responsive CSS
+- Deploy to Cloudflare Pages + GitHub Pages
+- SSE live reload in `selfdoc serve`

selfdoc-0.3.1/CLAUDE.md

@@ -0,0 +1,44 @@
+# selfdoc
+
+Code-aware static site generator that resolves `:::directive` blocks in Markdown templates into content extracted from source code. Supports Python, Go, and TypeScript/JavaScript.
+
+## Conventions
+
+- Pure Python, zero runtime dependencies (stdlib only)
+- Build system: hatchling
+- Development: `uv` for all Python tooling (`uv sync`, `uv run`, `uv add`)
+- Local development install: `uv pip install -e .`
+- npm package is a thin Node wrapper (`bin/cli.js`) that delegates to `python3 -m selfdoc`
+- File writes to shared state use atomic write (write to tmp, then `os.replace`)
+- External calls (subprocess, network) must have timeouts
+
+## Release workflow
+
+This project uses [rlsbl](https://github.com/smm-h/rlsbl) for release orchestration.
+
+- Update CHANGELOG.md with a `## X.Y.Z` entry describing changes
+- Run `rlsbl release [patch|minor|major]` to bump version and create a GitHub Release
+- CI handles publishing automatically via the publish workflow
+- Never publish manually -- always use `rlsbl release`
+- Requires NPM_TOKEN secret on GitHub (Settings > Secrets > Actions)
+- Use `rlsbl release --dry-run` to preview a release without making changes
+
+## Testing
+
+```bash
+uv run pytest
+```
+
+Tests live in `tests/` and cover config loading, directive parsing, the build pipeline, and language-specific extractors (Python, Go).
+
+## Architecture
+
+- **Directive parser** (`selfdoc/directives.py`): state machine that tracks fenced code blocks and `:::name arg` / `:::` pairs. Two entry points: `parse_directives` (extract) and `resolve_directives` (replace in-place with resolver output).
+- **Resolver** (`selfdoc/resolver.py`): factory that returns a `(name, arg, body) -> str` callable. Custom directives (from `selfdoc.json`) are checked first; otherwise dispatches to the language-specific extractor.
+- **Extractors** (`selfdoc/extractors/`): per-language modules (`python.py`, `go.py`, `typescript.py`). Python uses `ast`; Go and TypeScript use regex-based parsing. Each extractor handles all 5 built-in directives (module, schema, test, cli, config).
+- **Build** (`selfdoc/build.py`): scans `docs/` for `.md` templates, runs `resolve_directives` on each, converts to HTML, writes to output directory.
+- **HTML** (`selfdoc/html.py`): built-in Markdown-to-HTML converter (no dependencies). Produces a static site with sidebar navigation and responsive CSS.
+- **Config** (`selfdoc/config.py`): loads and validates `selfdoc.json`. Valid languages: python, go, typescript, javascript. Valid deploy providers: cloudflare-pages, github-pages.
+- **Deploy** (`selfdoc/deploy.py`): Cloudflare Pages (via wrangler CLI) and GitHub Pages (force-push to gh-pages branch).
+- **Check** (`selfdoc/check.py`): validates all directives resolve without error; computes documentation coverage (Python only: public symbol count vs. documented symbols).
+- **CLI** (`selfdoc/cli.py`): argparse-based, subcommands: init, build, serve, deploy, check. Serve uses SSE-based live reload with mtime polling.

selfdoc-0.3.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 smm-h
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

selfdoc-0.3.1/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.4
+Name: selfdoc
+Version: 0.3.1
+Summary: Code-aware static site generator with directive-based content extraction
+Project-URL: Repository, https://github.com/smm-h/selfdoc
+Author: smm-h
+License-Expression: MIT
+License-File: LICENSE
+Keywords: docstring,documentation,jsdoc,rlsbl,selfdoc,static-site-generator
+Requires-Python: >=3.11
+Provides-Extra: og
+Requires-Dist: predraw>=0.2.0; extra == 'og'
+Provides-Extra: perf
+Requires-Dist: brotli>=1.1; extra == 'perf'
+Description-Content-Type: text/markdown
+
+# selfdoc
+
+Code-aware static site generator that resolves `:::directive` blocks in Markdown templates into live content extracted from your source code.
+
+Supports Python, Go, and TypeScript/JavaScript. Zero runtime dependencies -- pure Python stdlib.
+
+## Install
+
+```
+pip install selfdoc
+```
+
+or via npm (delegates to Python under the hood):
+
+```
+npm install -g selfdoc
+```
+
+Requires Python 3.11+.
+
+## Quick start
+
+```bash
+# Initialize in an existing project (auto-detects language)
+selfdoc init
+
+# Edit docs/index.md -- add directives referencing your code
+# (see Directive syntax below)
+
+# Build HTML output
+selfdoc build
+
+# Serve locally with live reload
+selfdoc serve
+```
+
+## Directive syntax
+
+Directives are fenced blocks in your Markdown templates. They get replaced with content extracted from your source code at build time.
+
+```
+:::name arg
+:::
+```
+
+Everything between `:::name arg` and the closing `:::` is the directive body (optional, depends on the directive). Directives inside fenced code blocks are ignored.
+
+## Built-in directives
+
+| Directive | Arg | Description |
+| --------- | --- | ----------- |
+| `module` | dotted.path or file path | Extract module/package docstrings, exported functions, classes |
+| `schema` | file.json or module ClassName | Extract dataclass fields or JSON keys as a table |
+| `test` | file_path [TestName] | Embed test source code (whole file or specific function/class) |
+| `cli` | module path | Extract CLI help/usage text and flag definitions |
+| `config` | file path | Render JSON/TOML config files as key-value tables |
+
+Example -- embed the API docs for a Python module:
+
+```markdown
+## API Reference
+
+:::module selfdoc.config
+:::
+```
+
+Example -- show a JSON schema as a table:
+
+```markdown
+:::schema selfdoc.json
+:::
+```
+
+## Custom directives
+
+Register custom directives in `selfdoc.json` under the `directives` key. Each entry maps a directive name to a Python script (relative to project root) that exports a `resolve(arg, config)` function returning a Markdown string.
+
+```json
+{
+  "directives": {
+    "changelog": "scripts/changelog_directive.py"
+  }
+}
+```
+
+Script interface:
+
+```python
+def resolve(arg: str, config: dict) -> str:
+    """Return Markdown string to replace the directive block."""
+    ...
+```
+
+Use in templates:
+
+```markdown
+:::changelog v1.0.0
+:::
+```
+
+Custom directives take priority over built-in names.
+
+## Configuration
+
+`selfdoc.json` at the project root:
+
+```json
+{
+  "language": "python",
+  "source": ["selfdoc/"],
+  "docs": "docs/",
+  "output": "docs/_build/",
+  "deploy": {
+    "provider": "cloudflare-pages",
+    "project": "my-docs"
+  },
+  "directives": {}
+}
+```
+
+| Field | Required | Default | Description |
+| ----- | -------- | ------- | ----------- |
+| `language` | yes | -- | `python`, `go`, `typescript`, or `javascript` |
+| `source` | yes | -- | List of source directories to scan |
+| `docs` | no | `docs/` | Directory containing Markdown templates |
+| `output` | no | `docs/_build/` | Directory for generated HTML output |
+| `deploy` | no | -- | Deploy provider config (see Deploy below) |
+| `directives` | no | `{}` | Custom directive script mappings |
+
+`selfdoc init` auto-detects language and source paths from project files (pyproject.toml, go.mod, tsconfig.json, package.json).
+
+## Commands
+
+| Command | Description |
+| ------- | ----------- |
+| `selfdoc init` | Initialize selfdoc in the current project (creates selfdoc.json + starter template) |
+| `selfdoc build` | Resolve directives and generate HTML to the output directory |
+| `selfdoc serve [--port PORT]` | Serve built docs locally with SSE-based live reload (default port 8000) |
+| `selfdoc deploy` | Deploy docs to the configured provider |
+| `selfdoc check` | Validate all directives resolve successfully; report documentation coverage |
+
+## Deploy
+
+### Cloudflare Pages
+
+Requires the [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/) installed and authenticated.
+
+```json
+{
+  "deploy": {
+    "provider": "cloudflare-pages",
+    "project": "my-docs-project"
+  }
+}
+```
+
+```bash
+selfdoc build && selfdoc deploy
+```
+
+### GitHub Pages
+
+Pushes the output directory to the `gh-pages` branch via force-push.
+
+```json
+{
+  "deploy": {
+    "provider": "github-pages"
+  }
+}
+```
+
+Enable GitHub Pages in your repo settings (source: `gh-pages` branch).
+
+## Integration with rlsbl
+
+When [rlsbl](https://github.com/smm-h/rlsbl) detects a `selfdoc.json` in the project, it can trigger `selfdoc build` and `selfdoc deploy` as part of the release lifecycle via the `.rlsbl/hooks/post-release.sh` hook.
+
+## License
+
+MIT