Skip to content

Conversation

teneplaysofficial
Copy link
Contributor

@teneplaysofficial teneplaysofficial commented May 19, 2025

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

@sy-records sy-records merged commit e64c0ab into docsifyjs:master May 20, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants