badge-generator

badge-generator copied to clipboard

This goes to /docs/ or https://USERNAME.github.io/REPO_NAME (assuming that is a docs site but you can always add a subpath like /docs to the URL.

I would be nice to change between docs site dynamic link (default to GH Pages root) and a flag to go to docs folder instead. Then it makes sense on the Repo page.

<div align="center">

[![View - Project Docs](https://img.shields.io/badge/View-Project_Docs-blue?style=for-the-badge)](/docs/)

</div>

Also

[![view - Wiki](https://img.shields.io/badge/view-Wiki-blue)](https://github.com/MichaelCurrin/auto-commit-msg/wiki)

Or

[![View docs](https://img.shields.io/badge/View-Docs-green?style=for-the-badge)](https://michaelcurrin.github.io/github-graphql-tool/)

This fits well when adding GH Pages site button on Repo page but just uses docs.

You could use "Online docs" or "Docs site". But "Docs" is fine - it doesn't matter whether a folder or site when making the badge text.

Don't care about overriding the URL - using GH Pages is fine as that is mostly what I need. For /docs/ see the catalogue page - maybe generate on Repo page too? Maybe if GH Pages is not ticked then generate as /docs/. And a flag that GH Pages is actually a docs site so wording is "View: Docs" and not "View: GH Pages" or "View: Site"