Surge-MkDocs

https://github.com/fu-sen/Surge-MkDocs

MkDocs with Surge (minimal configuration)

• Surge
• MkDocs

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.
5. The API Key will be displayed, so save this text string.
6. Select Settings for your GitHub project.
7. Select Secrets and variables in Secrets.
8. Select Actions
9. Select New repository secrets.
10. Enter SURGE_LOGIN in Name and Surge login email in Value.
11. Select New repository secrets.
12. Enter SURGE_TOKEN in Name and token in Value.
13. Commit to a GitHub project: git push