https://github.com/mvdkleijn/vanity-builder

Simple tool that takes a YAML based config and generates a set of static HTML files that can be used for vanity URLs.
https://github.com/mvdkleijn/vanity-builder

go html static vanity-address vanity-url yaml

Last synced: 2 months ago
JSON representation

Simple tool that takes a YAML based config and generates a set of static HTML files that can be used for vanity URLs.

• Host: GitHub
• URL: https://github.com/mvdkleijn/vanity-builder
• Owner: mvdkleijn
• License: mit
• Created: 2024-02-16T00:45:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-08T07:21:35.000Z (over 1 year ago)
• Last Synced: 2025-02-21T12:48:17.486Z (over 1 year ago)
• Topics: go, html, static, vanity-address, vanity-url, yaml
• Language: Go
• Homepage:
• Size: 12.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/mvdkleijn/vanity-builder?style=for-the-badge)

[![Codacy grade](https://img.shields.io/codacy/grade/85218c426eca4f4fa4a70e4f5c947889?style=for-the-badge)](https://app.codacy.com/gh/mvdkleijn/vanity-builder)

[![Go Report Card](https://goreportcard.com/badge/github.com/mvdkleijn/vanity-builder?style=for-the-badge)](https://goreportcard.com/report/github.com/mvdkleijn/vanity-builder) [![Liberapay patrons](https://img.shields.io/liberapay/patrons/mvdkleijn?style=for-the-badge)](https://liberapay.com/mvdkleijn/) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O4O7H6C73)

# vanity-builder

Simple tool that takes a YAML based config and generates a set of static HTML files

based on Go templates that can be used for vanity URL self-hosting.

**Example**

Use `code.vanderkleijn.net` instead of `github.com` for your modules.

**Why?**

- No renaming issues when (for whatever reason) you're moving away from Github to somewhere else;

- Code can still be hosted on Github (or other places);

_In other words:_ similar to gopkg.in but easily self-hostable.

## Development notes

go-import: `/ git https://github.com//.git`

go-source: `content="   "`

Where:

  - prefix: `/`

    - The import path corresponding to the repo root

    - `` can include major version, e.g. `moduleName` or `moduleName/v2`

  - homepage: ``

    - The url of the repo's homepage

    - The '_' character can be used to signify the absence of a homepage

  - directory template: `https://github.com///tree/{/dir}`

    - An template used to create the URL for listing the files in the module

  - file template: `https://github.com///blob/{/dir}/{file}#L{line}`

    - An template used to create the url that points to a line in a file