Melkeydev / go-blueprint

Go-blueprint allows users to spin up a quick Go project using a popular framework
https://docs.go-blueprint.dev/
MIT License
5.89k stars 333 forks source link

Fetaure/Docs https://go-blueprint.com/ #160

Closed Ujstor closed 10 months ago

Ujstor commented 11 months ago

By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.

Project documentation that is easy to edit and can be automatically deployed to GitHub Pages with a custom domain

Description of Changes:

Someone has asked for docs, so I have created the first template that can be easily edited in markup. I am not an expert in writing docs, so feel free to open a PR in my repo if you have any changes in content or structure in mind.

Config: GitHub Actions would automatically create and update the new 'gh-pages' branch on push.

By default, the domain is https://melkydev.github.io/go-blueprint/

For a custom domain, we can choose from go-blueprint.com, .net, or .org. Additional configuration is needed. @Melkydev, you need to verify the domain in your GitHub account settings and send me the DNS TXT record.

https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/verifying-your-custom-domain-for-github-pages

After the first workflow run, add this configuration in the repository settings/pages.

Screenshot from 2023-12-26 11-44-32

After that everything is automated.

This is preview from my repo https://go-blueprint.com/, net and org are redirected.