Fetaure/Docs https://go-blueprint.com/ #160
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Melkeydev
approved these changes
Jan 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
After that everything is automated.
This is preview from my repo https://go-blueprint.com/, net and org are redirected.