https://github.com/fu-sen/surge-mkdocs
📃 MkDocs with ⚡ Surge (minimal configuration)
https://github.com/fu-sen/surge-mkdocs
github-actions mkdocs surge surge-sh surgesh
Last synced: 2 months ago
JSON representation
📃 MkDocs with ⚡ Surge (minimal configuration)
- Host: GitHub
- URL: https://github.com/fu-sen/surge-mkdocs
- Owner: fu-sen
- Created: 2022-06-13T06:04:13.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-06-22T12:17:51.000Z (about 1 year ago)
- Last Synced: 2025-06-22T22:37:04.425Z (about 1 year ago)
- Topics: github-actions, mkdocs, surge, surge-sh, surgesh
- Homepage: https://surge-mkdocs.balloon.net.eu.org
- Size: 14.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Surge-MkDocs
**MkDocs with Surge (minimal configuration)**
- [Surge](https://surge.sh/)
- [MkDocs](https://www.mkdocs.org/)
## How to use
1. Edit `mkdocs.yml` and `docs/index.md`, add more files if needed.
2. Change the `docs/CNAME` to the desired `example.surge.sh`. Or you can use the custom domain `example.com`
3. Add the pip package to `requirements.txt` . (Themes and plugins)
4. Get a token with the command `surge token`.
6. The API Key will be displayed, so save this text string.
7. Select `Settings` for your GitHub project.
8. Select `Secrets and variables ` in `Secrets`.
9. Select `Actions`
10. Select `New repository secrets`.
11. Enter `SURGE_LOGIN` in Name and Surge login email in Value.
12. Select `New repository secrets`.
13. Enter `SURGE_TOKEN` in Name and token in Value.
14. Commit to a GitHub project: `git push`
## Build error
Many of the build error are that you mistyped `mkdocs.yml`\
or you forgot to add the package to` requirements.txt`.\
Check the file change immediately before the error occurred.
This is often not a problem with this project.\
You should not open an issue for that.
## Note
`*.surge.sh/robots.txt` is fixed.\
**`*.surge.sh` rejects the search engine crawler.**
If you want to use Surge properly, use Custom Domain.
This sample also uses the [EU.org domains](https://nic.eu.org/),
and Surge deploys it with a custom domains.