Repository navigation
Release v1.0.0
Initial Production Release – v1.0.0
We’re excited to announce the first major production ready release of Docsify Sitemap Generator!
Generate a sitemap.xml for your Docsify site in seconds SEO friendly, standards compliant, and packed with useful features.
Features
- GitHub Repo Crawler: Automatically fetches all
.mdfiles 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-sitemapOr run it fully configured:
npx docsify-sitemap --url https://username.github.io/repo --owner username --repo repo --branch main --pat YOUR_PAT --output ./sitemap.xmlTry It Now
-
Live Web UI: https://docsify-sitemap.js.org
-
Install Locally:
npm install docsify-sitemap --save-dev
-
Install globally:
npm install -g docsify-sitemap