README
¶
Go Vanity HTML Renderer
Go Vanity HTML Renderer generates the html pages to use with GitHub Pages that allows you to set custom import paths for your Go packages.
Prerequisites
Go >= 1.24
Install
go get go.nhat.io/vanityrender
Usage
$ vanityrender --help
-config string
config file (default "config.json")
-homepage-tpl string
template file
-modules string
rebuild only the listed modules, comma separated
-out string
output path (default "build")
Examples
$ vanityrender -config config.json -out build
Donation
If this project help you reduce time to develop, you can give me a cup of coffee :)
Paypal donation
or scan this
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package main is the entry point of the application.
|
Package main is the entry point of the application. |
|
internal
|
|
|
cli
Package cli provides the cli interface.
|
Package cli provides the cli interface. |
|
config
Package config provides configuration.
|
Package config provides configuration. |
|
errors
Package errors provides error types.
|
Package errors provides error types. |
|
git
Package git provides functionalities to hydrate the configuration.
|
Package git provides functionalities to hydrate the configuration. |
|
github
Package github provides functionalities to decorate a repository with modules.
|
Package github provides functionalities to decorate a repository with modules. |
|
module
Package module provides functionalities for working with module path and versions.
|
Package module provides functionalities for working with module path and versions. |
|
must
Package must is a helper package for assertion at runtime.
|
Package must is a helper package for assertion at runtime. |
|
service/sitecache
Package sitecache provides functionalities for caching site configuration.
|
Package sitecache provides functionalities for caching site configuration. |
|
service/sitefragment
Package sitefragment provides functionalities for hydrating some fragments of the site configuration.
|
Package sitefragment provides functionalities for hydrating some fragments of the site configuration. |
|
site
Package site provides site configuration.
|
Package site provides site configuration. |
|
version
Package version provides build information.
|
Package version provides build information. |
|
Package templates provides the embedded templates.
|
Package templates provides the embedded templates. |
Click to show internal directories.
Click to hide internal directories.