{"id":28326787,"url":"https://github.com/tenelabs/docsify-sitemap","last_synced_at":"2026-01-24T08:32:30.075Z","repository":{"id":294213346,"uuid":"981709200","full_name":"tenelabs/docsify-sitemap","owner":"tenelabs","description":"Generate a sitemap for docsify project.","archived":false,"fork":false,"pushed_at":"2025-12-27T16:20:18.000Z","size":261,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-29T13:24:14.102Z","etag":null,"topics":["docsify","docsify-plugin","docsify-sitemap","docsify-tool"],"latest_commit_sha":null,"homepage":"http://docsify-sitemap.js.org","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tenelabs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-05-11T18:06:43.000Z","updated_at":"2025-12-27T16:20:16.000Z","dependencies_parsed_at":"2025-05-19T11:52:27.714Z","dependency_job_id":"d21608b5-c148-43eb-9013-438e997a8b2b","html_url":"https://github.com/tenelabs/docsify-sitemap","commit_stats":null,"previous_names":["tenelabs/docsify-sitemap"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/tenelabs/docsify-sitemap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenelabs%2Fdocsify-sitemap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenelabs%2Fdocsify-sitemap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenelabs%2Fdocsify-sitemap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenelabs%2Fdocsify-sitemap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tenelabs","download_url":"https://codeload.github.com/tenelabs/docsify-sitemap/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tenelabs%2Fdocsify-sitemap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28720776,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T08:27:05.734Z","status":"ssl_error","status_checked_at":"2026-01-24T08:27:01.197Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docsify","docsify-plugin","docsify-sitemap","docsify-tool"],"created_at":"2025-05-26T00:13:50.858Z","updated_at":"2026-01-24T08:32:30.070Z","avatar_url":"https://github.com/tenelabs.png","language":"HTML","readme":"# Docsify Sitemap Generator\n\nGenerate an SEO friendly `sitemap.xml` for your Docsify site in seconds.\n\nThis tool supports both local filesystem crawling and GitHub repository integration, giving you maximum flexibility.\n\n## Features\n\n- **Local \u0026 GitHub**: Crawl Markdown files locally or fetch from a GitHub repo.\n- **Sitemap Standards**: Generates a fully compliant `sitemap.xml` for optimal search engine indexing.\n- **Rate Limit Friendly**: Support for GitHub Personal Access Tokens (PAT) to avoid API throttling.\n- **Customizable**: Configure base directories, branches, output paths, and more.\n- **Flexible Workflows**: Use via CLI or Web UI choose what fits your pipeline.\n\n## Live Demo\n\nTry it now without installing: [Docsify Sitemap Generator Web UI](https://tenelabs.github.io/docsify-sitemap)\n\n### Preview\n\n![Image](https://github.com/user-attachments/assets/47208805-a84e-4a5a-959b-3eb412752fff)\n\n## Installation\n\nInstall as a development dependency:\n\n```bash\nnpm install --save-dev docsify-sitemap\n# or\nyarn add --dev docsify-sitemap\n```\n\nOr globally:\n\n```bash\nnpm install -g docsify-sitemap\n# or\nyarn global add docsify-sitemap\n```\n\n## Quick Start\n\nRun the CLI and follow prompts:\n\n```bash\nnpx docsify-sitemap\n```\n\nYou’ll be asked for your site URL, GitHub repo details (if applicable), and output location. A `sitemap.xml` file will be generated in your project.\n\n## CLI Usage\n\n```bash\ndocsify-sitemap [command] [options]\n```\n\n### Commands\n\n| Command | Description                                |\n| ------- | ------------------------------------------ |\n| `local` | Generate sitemap from local Markdown files |\n\n### Global Options\n\n| Flag                          | Description                                                               |\n| ----------------------------- | ------------------------------------------------------------------------- |\n| `-u, --url \u003curl\u003e`             | **(required)** Website URL (e.g. `https://user.github.io/repo`)           |\n| `-o, --owner \u003co\u003e`             | GitHub owner or organization (required for repo mode)                     |\n| `-r, --repo \u003cr\u003e`              | GitHub repository name (required for repo mode)                           |\n| `-b, --base \u003cdir\u003e`            | Base directory within repo or local path (default: `.`)                   |\n| `-B, --branch \u003cb\u003e`            | Git branch (default: `main`)                                              |\n| `-p, --pat \u003ctoken\u003e`           | GitHub Personal Access Token for private repos or higher rate limit       |\n| `-f, --output \u003cf\u003e`            | Output path and filename (default: `./public/sitemap.xml`)                |\n| `-i, --ignore-dot-underscore` | Ignore files and folders starting with `_` or `.` when generating sitemap |\n| `-h, --help`                  | Display help for commands                                                 |\n| `-V, --version`               | Output the current version                                                |\n\n### Examples\n\n#### Basic use\n\n```bash\nnpx docsify-sitemap \\\n  -u https://user.github.io/repo \\\n  -o user \\\n  -r repo \\\n  -b docs \\\n  -p YOUR_GH_PAT \\\n  -f ./docs/sitemap.xml\n  -i\n```\n\n#### Automated GitHub Action\n\n```yaml\nname: Generate Sitemap\n\non:\n  push:\n    paths:\n      - \"**/*.md\"\n  workflow_dispatch:\n\npermissions:\n  contents: write\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n\n    steps:\n      - uses: actions/checkout@v4\n      - uses: actions/setup-node@v4\n        with:\n          node-version: 20\n      - name: Generate sitemap\n        run: npx docsify-sitemap local -u WEBSITE_URL\n      - name: Commit sitemap\n        run: |\n          git config user.name 'github-actions[bot]'\n          git config user.email '41898282+github-actions[bot]@users.noreply.github.com'\n          git add .\n          git diff --cached --quiet || git commit -m 'chore: update sitemap.xml'\n          git push\n```\n\n\u003c!-- ## Configuration File (Optional)\n\nCreate a `docsify-sitemap.config.json` in your project root:\n\n```json\n{\n  \"url\": \"https://user.github.io/repo\",\n  \"owner\": \"user\",\n  \"repo\": \"repo\",\n  \"branch\": \"main\",\n  \"pat\": \"YOUR_PAT\",\n  \"output\": \"./public/sitemap.xml\",\n  \"base\": \"docs\"\n}\n```\n\nThen run:\n\n```bash\nnpx docsify-sitemap --config docsify-sitemap.config.json\n``` --\u003e\n\n## 🔧 API \u0026 Options Reference\n\n| Option                  | Type      | Default                | Description                                       |\n| ----------------------- | --------- | ---------------------- | ------------------------------------------------- |\n| `url`                   | `string`  | —                      | **Required.** Site URL or GitHub Pages URL        |\n| `owner`                 | `string`  | —                      | GitHub owner/org (for repo mode)                  |\n| `repo`                  | `string`  | —                      | Repository name (for repo mode)                   |\n| `branch`                | `string`  | `main`                 | Branch containing your Docsify site               |\n| `base`                  | `string`  | `.`                    | Base folder in repo or local filesystem           |\n| `pat`                   | `string`  | —                      | GitHub PAT to increase rate limit                 |\n| `output`                | `string`  | `./public/sitemap.xml` | Output file path                                  |\n| `ignore-dot-underscore` | `boolean` | `false`                | Ignore files and folders starting with `_` or `.` |\n\n\u003c!-- s| `config` | `string` | —                      | Path to JSON config file                   | --\u003e\n\n## Contributing\n\n1. Fork the repository\n2. Create a branch: `git checkout -b feature/your-feature`\n3. Make your changes and test\n4. Submit a pull request\n\nWe welcome enhancements, bug fixes, and documentation improvements. Please follow existing code style and conventions.\n\n## License\n\nThis project is licensed under the [MIT License](./LICENSE).\n","funding_links":[],"categories":["Community Resources"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftenelabs%2Fdocsify-sitemap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftenelabs%2Fdocsify-sitemap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftenelabs%2Fdocsify-sitemap/lists"}