{"id":21755110,"url":"https://github.com/fu-sen/surge-mkdocs","last_synced_at":"2026-04-24T12:03:30.967Z","repository":{"id":73183839,"uuid":"502825376","full_name":"fu-sen/Surge-MkDocs","owner":"fu-sen","description":"📃 MkDocs with ⚡ Surge (minimal configuration)","archived":false,"fork":false,"pushed_at":"2025-06-22T12:17:51.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-22T22:37:04.425Z","etag":null,"topics":["github-actions","mkdocs","surge","surge-sh","surgesh"],"latest_commit_sha":null,"homepage":"https://surge-mkdocs.balloon.net.eu.org","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fu-sen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2022-06-13T06:04:13.000Z","updated_at":"2025-06-22T12:17:54.000Z","dependencies_parsed_at":null,"dependency_job_id":"ea523e23-c57e-4ff9-b17c-3ed1727b42a4","html_url":"https://github.com/fu-sen/Surge-MkDocs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fu-sen/Surge-MkDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FSurge-MkDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FSurge-MkDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FSurge-MkDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FSurge-MkDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fu-sen","download_url":"https://codeload.github.com/fu-sen/Surge-MkDocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fu-sen%2FSurge-MkDocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32222483,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T10:26:35.452Z","status":"ssl_error","status_checked_at":"2026-04-24T10:25:27.643Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["github-actions","mkdocs","surge","surge-sh","surgesh"],"created_at":"2024-11-26T09:16:40.308Z","updated_at":"2026-04-24T12:03:30.962Z","avatar_url":"https://github.com/fu-sen.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- 2024/10/03 MkDocs 1.6.1 --\u003e\n\n## Surge-MkDocs\n\n**MkDocs with Surge (minimal configuration)**\n\n- [Surge](https://surge.sh/)\n- [MkDocs](https://www.mkdocs.org/)\n\n## How to use\n\n1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.\n2. Change the `docs/CNAME` to the desired `example.surge.sh`. Or you can use the custom domain `example.com`\n3. Add the pip package to `requirements.txt` . (Themes and plugins)\n4. Get a token with the command `surge token`.\n6. The API Key will be displayed, so save this text string.\n7. Select `Settings` for your GitHub project.\n8. Select `Secrets and variables ` in `Secrets`.\n9. Select `Actions`\n10. Select `New repository secrets`.\n11. Enter `SURGE_LOGIN` in Name and Surge login email in Value.\n12. Select `New repository secrets`.\n13. Enter `SURGE_TOKEN` in Name and token in Value.\n14. Commit to a GitHub project: `git push`\n\n## Build error\n\nMany of the build error are that you mistyped `mkdocs.yml`\\\nor you forgot to add the package to` requirements.txt`.\\\nCheck the file change immediately before the error occurred.\n\nThis is often not a problem with this project.\\\nYou should not open an issue for that.\n\n## Note\n\n`*.surge.sh/robots.txt` is fixed.\\\n**`*.surge.sh` rejects the search engine crawler.**\n\nIf you want to use Surge properly, use Custom Domain.\n\nThis sample also uses the [EU.org domains](https://nic.eu.org/),\nand Surge deploys it with a custom domains.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffu-sen%2Fsurge-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffu-sen%2Fsurge-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffu-sen%2Fsurge-mkdocs/lists"}