Features

• GitHub Repo Crawler: Automatically fetches all .md files from any public GitHub repository.
• Local Mode: Generate sitemap directly from local markdown files — no GitHub needed.
• Standards-compliant sitemap.xml: Fully valid and optimized for search engines.
• Interactive CLI: Prompt-driven interface makes setup simple and quick.
• GitHub PAT Support: Use Personal Access Tokens to avoid rate limits.
• Branch & Base Support: Target specific branches and directories for sitemap generation.
• Configurable Output Path: Customize where your sitemap is written (default: .public/sitemap.xml).
• GitHub Workflow Integration: Seamless CI/CD automation with ready-to-use GitHub Actions.
• Web UI (Demo): Try it instantly online no installation required: Live Demo

Usage

npx docsify-sitemap

Or run it fully configured:

npx docsify-sitemap --url https://username.github.io/repo --owner username --repo repo --branch main --pat YOUR_PAT --output ./sitemap.xml

Try It Now

• Live Web UI: https://tenelabs.github.io/docsify-sitemap