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: about 1 month 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 (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-03T10:34:01.000Z (2 months ago)
• Last Synced: 2024-11-03T11:21:02.415Z (2 months ago)
• Topics: github-actions, mkdocs, surge, surge-sh, surgesh
• Homepage: https://surge-mkdocs.balloon.net.eu.org
• Size: 7.81 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`.

5. Select `Settings` for your GitHub project.

6. Select `Actions` in `Secrets`.

7. Select `New repository secrets`.

8. Enter `SURGE_LOGIN` in Name and Surge login email in Value.

9. Select `New repository secrets`.

10. Enter `SURGE_TOKEN` in Name and token in Value.

11. 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.