Awesome Go
-
{{range .Links}}
- {{if .ProjectSlug}} {{.Description}} {{else}} {{.Description}} {{end}} {{end}}
[](https://github.com/avelino/awesome-go/actions/workflows/tests.yaml?query=branch%3Amain)
[](https://github.com/sindresorhus/awesome)
[](https://gophers.slack.com/messages/awesome)
[](https://app.netlify.com/sites/awesome-go/deploys)
[](https://www.trackawesomelist.com/avelino/awesome-go/)
[](https://github.com/avelino/awesome-go/commits/main)
We use the _[Golang Bridge](https://github.com/gobridge/about-us/blob/master/README.md)_ community Slack for instant communication, follow the [form here to join](https://invite.slack.golangbridge.org/).
**Sponsorships:**
_Special thanks to_
|
Expand contents
- [Awesome Go](#awesome-go) - [Contents](#contents) - [Actor Model](#actor-model) - [Artificial Intelligence](#artificial-intelligence) - [Audio and Music](#audio-and-music) - [Authentication and Authorization](#authentication-and-authorization) - [Blockchain](#blockchain) - [Bot Building](#bot-building) - [Build Automation](#build-automation) - [Command Line](#command-line) - [Advanced Console UIs](#advanced-console-uis) - [Standard CLI](#standard-cli) - [Configuration](#configuration) - [Continuous Integration](#continuous-integration) - [CSS Preprocessors](#css-preprocessors) - [Data Integration Frameworks](#data-integration-frameworks) - [Data Structures and Algorithms](#data-structures-and-algorithms) - [Bit-packing and Compression](#bit-packing-and-compression) - [Bit Sets](#bit-sets) - [Bloom and Cuckoo Filters](#bloom-and-cuckoo-filters) - [Data Structure and Algorithm Collections](#data-structure-and-algorithm-collections) - [Iterators](#iterators) - [Maps](#maps) - [Miscellaneous Data Structures and Algorithms](#miscellaneous-data-structures-and-algorithms) - [Nullable Types](#nullable-types) - [Queues](#queues) - [Sets](#sets) - [Text Analysis](#text-analysis) - [Trees](#trees) - [Pipes](#pipes) - [Database](#database) - [Caches](#caches) - [Databases Implemented in Go](#databases-implemented-in-go) - [Database Schema Migration](#database-schema-migration) - [Database Tools](#database-tools) - [SQL Query Builders](#sql-query-builders) - [Database Drivers](#database-drivers) - [Interfaces to Multiple Backends](#interfaces-to-multiple-backends) - [Relational Database Drivers](#relational-database-drivers) - [NoSQL Database Drivers](#nosql-database-drivers) - [Search and Analytic Databases](#search-and-analytic-databases) - [Date and Time](#date-and-time) - [Distributed Systems](#distributed-systems) - [Dynamic DNS](#dynamic-dns) - [Email](#email) - [Embeddable Scripting Languages](#embeddable-scripting-languages) - [Error Handling](#error-handling) - [File Handling](#file-handling) - [Financial](#financial) - [Forms](#forms) - [Functional](#functional) - [Game Development](#game-development) - [Generators](#generators) - [Geographic](#geographic) - [Go Compilers](#go-compilers) - [Goroutines](#goroutines) - [GUI](#gui) - [Hardware](#hardware) - [Images](#images) - [IoT (Internet of Things)](#iot-internet-of-things) - [Job Scheduler](#job-scheduler) - [JSON](#json) - [Logging](#logging) - [Machine Learning](#machine-learning) - [Messaging](#messaging) - [Microsoft Office](#microsoft-office) - [Microsoft Excel](#microsoft-excel) - [Microsoft Word](#microsoft-word) - [Miscellaneous](#miscellaneous) - [Dependency Injection](#dependency-injection) - [Project Layout](#project-layout) - [Strings](#strings) - [Uncategorized](#uncategorized) - [Natural Language Processing](#natural-language-processing) - [Language Detection](#language-detection) - [Morphological Analyzers](#morphological-analyzers) - [Slugifiers](#slugifiers) - [Tokenizers](#tokenizers) - [Translation](#translation) - [Transliteration](#transliteration) - [Networking](#networking) - [HTTP Clients](#http-clients) - [OpenGL](#opengl) - [ORM](#orm) - [Package Management](#package-management) - [Performance](#performance) - [Query Language](#query-language) - [Reflection](#reflection) - [Resource Embedding](#resource-embedding) - [Science and Data Analysis](#science-and-data-analysis) - [Security](#security) - [Serialization](#serialization) - [Server Applications](#server-applications) - [Stream Processing](#stream-processing) - [Template Engines](#template-engines) - [Testing](#testing) - [Testing Frameworks](#testing-frameworks) - [Mock](#mock) - [Fuzzing and delta-debugging/reducing/shrinking](#fuzzing-and-delta-debuggingreducingshrinking) - [Selenium and browser control tools](#selenium-and-browser-control-tools) - [Fail injection](#fail-injection) - [Text Processing](#text-processing) - [Formatters](#formatters) - [Markup Languages](#markup-languages) - [Parsers/Encoders/Decoders](#parsersencodersdecoders) - [Regular Expressions](#regular-expressions) - [Sanitation](#sanitation) - [Scrapers](#scrapers) - [RSS](#rss) - [Utility/Miscellaneous](#utilitymiscellaneous) - [Third-party APIs](#third-party-apis) - [Utilities](#utilities) - [UUID](#uuid) - [Validation](#validation) - [Version Control](#version-control) - [Video](#video) - [Web Frameworks](#web-frameworks) - [Middlewares](#middlewares) - [Actual middlewares](#actual-middlewares) - [Libraries for creating HTTP middlewares](#libraries-for-creating-http-middlewares) - [Routers](#routers) - [WebAssembly](#webassembly) - [Webhooks Server](#webhooks-server) - [Windows](#windows) - [Workflow Frameworks](#workflow-frameworks) - [XML](#xml) - [Zero Trust](#zero-trust) - [Code Analysis](#code-analysis) - [Editor Plugins](#editor-plugins) - [Go Generate Tools](#go-generate-tools) - [Go Tools](#go-tools) - [Software Packages](#software-packages) - [DevOps Tools](#devops-tools) - [Other Software](#other-software) - [Resources](#resources) - [Benchmarks](#benchmarks) - [Conferences](#conferences) - [E-Books](#e-books) - [E-books for purchase](#e-books-for-purchase) - [Free e-books](#free-e-books) - [Gophers](#gophers) - [Meetups](#meetups) - [Style Guides](#style-guides) - [Social Media](#social-media) - [Twitter](#twitter) - [Reddit](#reddit) - [Websites](#websites) - [Tutorials](#tutorials) - [Guided Learning](#guided-learning) - [Contribution](#contribution) - [License](#license) **[⬆ back to top](#contents)**- sibling and
- first
- second
- nested on second level
- nested on third level
strikethrough
- yet another second level item, but with a a link
- nested on second level
- end
- wrapped in
contentsList := contentsHeading.NextFiltered("ul")
if contentsList.Length() == 0 {
contentsList = contentsHeading.NextFiltered("details").Find("ul").First()
}
contentsList.
Find("ul").
EachWithBreak(func(_ int, selUl *goquery.Selection) bool {
if rootErr != nil {
return false
}
selUl.
Find("li a").
EachWithBreak(func(_ int, s *goquery.Selection) bool {
selector, exists := s.Attr("href")
if !exists {
return true
}
category, err := extractCategory(doc, selector)
if err != nil {
// Skip entries without links (e.g. #contents, #awesome-go)
return true
}
categories[selector] = *category
return true
})
return true
})
if rootErr != nil {
return nil, fmt.Errorf("extract categories: %w", rootErr)
}
return categories, nil
}
func extractCategory(doc *goquery.Document, selector string) (*Category, error) {
var category Category
var err error
doc.Find(selector).EachWithBreak(func(_ int, selCatHeader *goquery.Selection) bool {
selDescr := selCatHeader.NextFiltered("p")
// FIXME: bug. this would select links from all neighboring
// sub-categories until the next category. To prevent this we should
// find only first ul
ul := selCatHeader.NextFilteredUntil("ul", "h2")
var links []Link
ul.Find("li").Each(func(_ int, selLi *goquery.Selection) {
selLink := selLi.Find("a")
url, _ := selLink.Attr("href")
link := Link{
Title: selLink.Text(),
// FIXME(kazhuravlev): Title contains only title but
// description contains Title + description
Description: selLi.Text(),
URL: url,
}
links = append(links, link)
})
// FIXME: In this case we would have an empty category in main index.html with link to 404 page.
if len(links) == 0 {
err = errors.New("category does not contain links")
return false
}
category = Category{
Slug: slug.Generate(selCatHeader.Text()),
Title: selCatHeader.Text(),
Description: selDescr.Text(),
Links: links,
}
return true
})
if err != nil {
return nil, fmt.Errorf("build a category: %w", err)
}
return &category, nil
}
func rewriteLinksInIndex(doc *goquery.Document, categories map[string]Category) error {
var iterErr error
doc.
Find("body #content ul li ul li a").
EachWithBreak(func(_ int, s *goquery.Selection) bool {
href, hrefExists := s.Attr("href")
if !hrefExists {
// FIXME: looks like is an error. Tag `a` in our case always
// should have `href` attr.
return true
}
// do not replace links if no page has been created for it
_, catExists := categories[href]
if !catExists {
return true
}
linkURL, err := url.Parse(href)
if err != nil {
iterErr = err
return false
}
if linkURL.Fragment != "" && linkURL.Fragment != "contents" {
s.SetAttr("href", linkURL.Fragment)
}
return true
})
if iterErr != nil {
return iterErr
}
fmt.Printf("Rewrite links in Index file: %s\n", outIndexFile)
resultHTML, err := doc.Html()
if err != nil {
return fmt.Errorf("render html: %w", err)
}
if err := os.WriteFile(outIndexFile, []byte(resultHTML), 0644); err != nil {
return fmt.Errorf("rewrite index file: %w", err)
}
return nil
}
// renderIndex generate site html (index.html) from markdown file
func renderIndex(srcFilename, outFilename string) error {
input, err := os.ReadFile(srcFilename)
if err != nil {
return err
}
body, err := markdown.ToHTML(input)
if err != nil {
return err
}
f, err := os.Create(outFilename)
if err != nil {
return err
}
fmt.Printf("Write Index file: %s\n", outIndexFile)
data := map[string]interface{}{
"Body": template2.HTML(body),
}
if err := tpl.Lookup("index.tmpl.html").Execute(f, data); err != nil {
return err
}
if err := f.Close(); err != nil {
return fmt.Errorf("close index file: %w", err)
}
return nil
}
// parseRepoURL extracts host, owner, and repo from a GitHub or GitLab URL
func parseRepoURL(rawURL string) (host, owner, repo string, ok bool) {
u, err := url.Parse(rawURL)
if err != nil {
return "", "", "", false
}
parts := strings.Split(strings.Trim(u.Path, "/"), "/")
switch u.Hostname() {
case "github.com":
if len(parts) < 2 {
return "", "", "", false
}
return "github", parts[0], parts[1], true
case "gitlab.com":
if len(parts) < 2 {
return "", "", "", false
}
return "gitlab", parts[0], parts[len(parts)-1], true
}
return "", "", "", false
}
// buildProjects creates Project structs from category links and sets internal link slugs
func buildProjects(categories map[string]Category) []*Project {
var projects []*Project
for key, cat := range categories {
for i, link := range cat.Links {
host, owner, repo, ok := parseRepoURL(link.URL)
if !ok {
continue
}
projectSlug := slug.Generate(repo + "-" + owner + "-" + host)
cat.Links[i].ProjectSlug = projectSlug
p := &Project{
Title: link.Title,
URL: link.URL,
Description: link.Description,
Slug: projectSlug,
Host: host,
Owner: owner,
Repo: repo,
CategoryTitle: cat.Title,
CategorySlug: cat.Slug,
}
projects = append(projects, p)
}
categories[key] = cat
}
// Populate Related: group by category, pick up to 10 siblings
byCat := make(map[string][]*Project)
for _, p := range projects {
byCat[p.CategorySlug] = append(byCat[p.CategorySlug], p)
}
for _, p := range projects {
var related []Link
for _, s := range byCat[p.CategorySlug] {
if s.Slug == p.Slug {
continue
}
related = append(related, Link{
Title: s.Title,
URL: s.URL,
Description: s.Description,
ProjectSlug: s.Slug,
})
if len(related) >= 10 {
break
}
}
p.Related = related
}
fmt.Printf("Built %d project pages\n", len(projects))
return projects
}
// fetchProjectMeta fetches metadata from GitHub/GitLab APIs with file-per-repo caching
func fetchProjectMeta(projects []*Project) error {
if os.Getenv("AWESOME_SKIP_FETCH") != "" {
log.Println("AWESOME_SKIP_FETCH set, skipping metadata fetch")
return nil
}
token := os.Getenv("GITHUB_TOKEN")
client := &http.Client{Timeout: 10 * time.Second}
fetched := 0
for _, p := range projects {
cached, err := readCachedMeta(p)
if err == nil && cached != nil {
p.Meta = cached
continue
}
var meta *RepoMeta
switch p.Host {
case "github":
meta = fetchGitHubMeta(client, p.Owner, p.Repo, token)
case "gitlab":
meta = fetchGitLabMeta(client, p.URL)
}
if meta != nil {
meta.FetchedAt = time.Now().Format("2006-01-02")
p.Meta = meta
if err := writeCachedMeta(p, meta); err != nil {
log.Printf("warning: cache write failed for %s/%s: %v", p.Owner, p.Repo, err)
}
fetched++
}
time.Sleep(50 * time.Millisecond)
}
fmt.Printf("Fetched metadata for %d projects (%d from cache)\n", fetched, len(projects)-fetched)
return nil
}
func cacheFilePath(p *Project) string {
return filepath.Join(".cache", "repos", p.Owner, p.Repo+".json")
}
func readCachedMeta(p *Project) (*RepoMeta, error) {
data, err := os.ReadFile(cacheFilePath(p))
if err != nil {
return nil, err
}
var meta RepoMeta
if err := json.Unmarshal(data, &meta); err != nil {
return nil, err
}
fetchedAt, err := time.Parse("2006-01-02", meta.FetchedAt)
if err != nil {
return nil, err
}
if time.Since(fetchedAt) > 7*24*time.Hour {
return nil, fmt.Errorf("cache stale")
}
return &meta, nil
}
func writeCachedMeta(p *Project, meta *RepoMeta) error {
path := cacheFilePath(p)
if err := os.MkdirAll(filepath.Dir(path), 0755); err != nil {
return err
}
data, err := json.MarshalIndent(meta, "", " ")
if err != nil {
return err
}
return os.WriteFile(path, data, 0644)
}
func fetchGitHubMeta(client *http.Client, owner, repo, token string) *RepoMeta {
apiURL := fmt.Sprintf("https://api.github.com/repos/%s/%s", owner, repo)
req, err := http.NewRequest("GET", apiURL, nil)
if err != nil {
return nil
}
req.Header.Set("Accept", "application/vnd.github.v3+json")
if token != "" {
req.Header.Set("Authorization", "Bearer "+token)
}
resp, err := client.Do(req)
if err != nil {
return nil
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil
}
var ghRepo struct {
StargazersCount int `json:"stargazers_count"`
ForksCount int `json:"forks_count"`
License *struct {
SpdxID string `json:"spdx_id"`
} `json:"license"`
Language string `json:"language"`
Topics []string `json:"topics"`
PushedAt string `json:"pushed_at"`
OpenIssuesCount int `json:"open_issues_count"`
Archived bool `json:"archived"`
}
if err := json.Unmarshal(body, &ghRepo); err != nil {
return nil
}
license := ""
if ghRepo.License != nil {
license = ghRepo.License.SpdxID
}
lastPush := ""
if ghRepo.PushedAt != "" {
if t, err := time.Parse(time.RFC3339, ghRepo.PushedAt); err == nil {
lastPush = t.Format("2006-01-02")
}
}
return &RepoMeta{
Stars: ghRepo.StargazersCount,
Forks: ghRepo.ForksCount,
License: license,
Language: ghRepo.Language,
Topics: ghRepo.Topics,
LastPush: lastPush,
OpenIssues: ghRepo.OpenIssuesCount,
Archived: ghRepo.Archived,
}
}
func fetchGitLabMeta(client *http.Client, projectURL string) *RepoMeta {
u, err := url.Parse(projectURL)
if err != nil {
return nil
}
path := strings.Trim(u.Path, "/")
// Remove tree/branch paths (e.g., /-/tree/main/...)
if idx := strings.Index(path, "/-/"); idx != -1 {
path = path[:idx]
}
apiURL := fmt.Sprintf("https://gitlab.com/api/v4/projects/%s", url.PathEscape(path))
resp, err := client.Get(apiURL)
if err != nil {
return nil
}
defer resp.Body.Close()
if resp.StatusCode != http.StatusOK {
return nil
}
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil
}
var glProject struct {
StarCount int `json:"star_count"`
ForksCount int `json:"forks_count"`
License *struct {
Key string `json:"key"`
} `json:"license"`
Topics []string `json:"topics"`
LastActivityAt string `json:"last_activity_at"`
OpenIssuesCount int `json:"open_issues_count"`
Archived bool `json:"archived"`
}
if err := json.Unmarshal(body, &glProject); err != nil {
return nil
}
license := ""
if glProject.License != nil {
license = glProject.License.Key
}
lastPush := ""
if glProject.LastActivityAt != "" {
if t, err := time.Parse(time.RFC3339, glProject.LastActivityAt); err == nil {
lastPush = t.Format("2006-01-02")
}
}
return &RepoMeta{
Stars: glProject.StarCount,
Forks: glProject.ForksCount,
License: license,
Language: "Go",
Topics: glProject.Topics,
LastPush: lastPush,
OpenIssues: glProject.OpenIssuesCount,
Archived: glProject.Archived,
}
}
func renderProjects(projects []*Project) error {
for _, p := range projects {
projectDir := filepath.Join(outDir, p.CategorySlug, p.Slug)
if err := mkdirAll(projectDir); err != nil {
return fmt.Errorf("create project dir %s: %w", projectDir, err)
}
projectFile := filepath.Join(projectDir, "index.html")
buf := bytes.NewBuffer(nil)
if err := tpl.Lookup("project.tmpl.html").Execute(buf, p); err != nil {
return fmt.Errorf("render project %s: %w", p.Slug, err)
}
doc, err := goquery.NewDocumentFromReader(buf)
if err != nil {
return fmt.Errorf("goquery for project %s: %w", p.Slug, err)
}
html, err := doc.Html()
if err != nil {
return fmt.Errorf("html for project %s: %w", p.Slug, err)
}
if err := os.WriteFile(projectFile, []byte(html), 0644); err != nil {
return fmt.Errorf("write project file %s: %w", p.Slug, err)
}
}
fmt.Printf("Rendered %d project pages\n", len(projects))
return nil
}
================================================
FILE: main_test.go
================================================
package main
import (
"bytes"
"github.com/avelino/awesome-go/pkg/markdown"
"os"
"regexp"
"sort"
"strings"
"testing"
"github.com/PuerkitoBio/goquery"
)
var (
reContainsLink = regexp.MustCompile(`\* \[.*\]\(.*\)`)
reOnlyLink = regexp.MustCompile(`\* \[.*\]\([^()]*\)$`)
reLinkWithDescription = regexp.MustCompile(`\* \[.*\]\(.*\) - \S.*[\.\!]`)
)
func requireNoErr(t *testing.T, err error, msg string) {
// FIXME: replace to github.com/stretchr/testify
t.Helper()
if msg == "" {
msg = "unknown error"
}
if err != nil {
t.Fatalf("Received unexpected error [%s]: %+v", msg, err)
}
}
func goqueryFromReadme(t *testing.T) *goquery.Document {
t.Helper()
input, err := os.ReadFile(readmePath)
requireNoErr(t, err, "readme file should be exists")
html, err := markdown.ToHTML(input)
requireNoErr(t, err, "markdown should be rendered to html")
buf := bytes.NewBuffer(html)
doc, err := goquery.NewDocumentFromReader(buf)
requireNoErr(t, err, "html must be valid for goquery")
return doc
}
func TestAlpha(t *testing.T) {
doc := goqueryFromReadme(t)
doc.Find("body > ul").Each(func(i int, s *goquery.Selection) {
if i != 0 {
// skip content menu
// TODO: the sub items (with 3 hash marks `###`) are staying in
// the main list, not respecting the hierarchy and making it
// impossible to test the alphabetical order
testList(t, s)
}
})
}
func TestDuplicatedLinks(t *testing.T) {
doc := goqueryFromReadme(t)
links := make(map[string]bool, 0)
doc.Find("body li > a:first-child").Each(func(_ int, s *goquery.Selection) {
t.Run(s.Text(), func(t *testing.T) {
href, ok := s.Attr("href")
if !ok {
t.Error("expected to have href")
}
if links[href] {
t.Fatalf("duplicated link '%s'", href)
}
links[href] = true
})
})
}
// Test if an entry has description, it must be separated from link with ` - `
func TestSeparator(t *testing.T) {
var matched, containsLink, noDescription bool
input, err := os.ReadFile(readmePath)
requireNoErr(t, err, "readme should be exists")
lines := strings.Split(string(input), "\n")
for _, line := range lines {
line = strings.Trim(line, " ")
containsLink = reContainsLink.MatchString(line)
if containsLink {
noDescription = reOnlyLink.MatchString(line)
if noDescription {
continue
}
matched = reLinkWithDescription.MatchString(line)
if !matched {
t.Errorf("expected entry to be in form of `* [link] - description.`, got '%s'", line)
}
}
}
}
func TestRenderIndex(t *testing.T) {
requireNoErr(t, mkdirAll(outDir), "output dir should exists")
err := renderIndex(readmePath, outIndexFile)
requireNoErr(t, err, "html should be rendered")
}
func testList(t *testing.T, list *goquery.Selection) {
list.Find("ul").Each(func(_ int, items *goquery.Selection) {
testList(t, items)
items.RemoveFiltered("ul")
})
t.Run(list.Prev().Text(), func(t *testing.T) {
checkAlphabeticOrder(t, list)
})
}
func checkAlphabeticOrder(t *testing.T, s *goquery.Selection) {
items := s.Find("li > a:first-child").Map(func(_ int, li *goquery.Selection) string {
return strings.ToLower(li.Text())
})
sorted := make([]string, len(items))
copy(sorted, items)
sort.Strings(sorted)
for k, item := range items {
if item != sorted[k] {
t.Errorf("expected '%s' but actual is '%s'", sorted[k], item)
}
}
if t.Failed() {
t.Logf("expected order is:\n%s", strings.Join(sorted, "\n"))
}
}
================================================
FILE: maturity_test.go
================================================
package main
import (
"encoding/json"
"fmt"
"net/http"
"os"
"strings"
"testing"
"time"
"github.com/PuerkitoBio/goquery"
)
var (
githubApiAuthorizationToken = os.Getenv("GITHUB_API_TOKEN")
minimumMaturityDate = time.Now().AddDate(0, -5, 0)
)
func TestMaturity(t *testing.T) {
doc := goqueryFromReadme(t)
doc.Find("body li > a:first-child").Each(func(_ int, s *goquery.Selection) {
t.Run(s.Text(), func(t *testing.T) {
href, ok := s.Attr("href")
if !ok {
t.Error("expected to have href")
}
matches := reGithubRepo.FindStringSubmatch(href)
if matches == nil {
return
}
if len(matches) != 3 {
t.Fatalf("failed to extract repo and user from: %s, got [%v]", href, strings.Join(matches, ", "))
}
if err := checkRepositoryMaturity(matches[1], matches[2]); err != nil {
t.Fatal(err)
}
})
})
}
func checkRepositoryMaturity(user, repo string) error {
until := minimumMaturityDate.Format(time.RFC3339)
url := fmt.Sprintf("https://api.github.com/repos/%s/%s/commits?per_page=1&until=%s", user, repo, until)
request, err := http.NewRequest(http.MethodGet, url, nil)
if err != nil {
return fmt.Errorf("failed to create request for `%s`, %v", url, err)
}
request.Header.Set("Accept", "application/vnd.github+json")
request.Header.Set("X-GitHub-Api-Version", "2022-11-28")
request.Header.Set("User-Agent", "avelino")
request.Header.Set("Authorization", "Bearer "+githubApiAuthorizationToken)
http.DefaultClient.Timeout = time.Minute
httpRes, err := http.DefaultClient.Do(request)
if err != nil {
return fmt.Errorf("failed to fetch commits for [%s/%s], %v", user, repo, err)
}
defer httpRes.Body.Close()
var commits []any
err = json.NewDecoder(httpRes.Body).Decode(&commits)
if err != nil {
return fmt.Errorf("failed to decode response for [%s/%s], %v", user, repo, err)
}
if len(commits) == 0 {
minimumDate := minimumMaturityDate.Format(time.DateOnly)
return fmt.Errorf("the project [%s/%s] doesn't have any commits before %s, this is a maturity violation", user, repo, minimumDate)
}
return nil
}
================================================
FILE: netlify.toml
================================================
# Settings in the [build] context are global and are applied to
# all contexts unless otherwise overridden by more specific contexts.
[build]
# Directory to change to before starting a build.
# This is where we will look for package.json/.nvmrc/etc.
# If not set, defaults to the root directory.
base = "./"
# Directory that contains the deploy-ready HTML files and
# assets generated by the build. This is relative to the base
# directory if one has been set, or the root directory if
# a base has not been set. This sample publishes the directory
# located at the absolute path "root/project/build-output"
publish = "out/"
# Default build command.
command = "echo 'default context'"
[[plugins]]
# Installs the Lighthouse Build Plugin for all deploy contexts
package = "@netlify/plugin-lighthouse"
# Production context: all deploys from the Production branch
# set in your site’s Branches settings in the UI will inherit
# these settings. You can define environment variables
# here but we recommend using the Netlify UI for sensitive
# values to keep them out of your source repository.
[context.production]
publish = "out/"
# Redirects and headers are GLOBAL for all builds – they do not
# get scoped to contexts no matter where you define them in the file.
# For context-specific rules, use _headers or _redirects files,
# which are PER-DEPLOY.
[[redirects]]
from = "/awesome-cloud-native"
to = "/"
status = 302
force = true
[[redirects]]
from = "/awesome-go-fork"
to = "/"
status = 302
force = true
================================================
FILE: pkg/markdown/convert.go
================================================
package markdown
import (
"bytes"
"github.com/avelino/awesome-go/pkg/slug"
"github.com/yuin/goldmark"
"github.com/yuin/goldmark/ast"
"github.com/yuin/goldmark/extension"
"github.com/yuin/goldmark/parser"
"github.com/yuin/goldmark/renderer/html"
"github.com/yuin/goldmark/util"
)
// ToHTML converts markdown byte slice to a HTML byte slice
func ToHTML(markdown []byte) ([]byte, error) {
md := goldmark.New(
goldmark.WithExtensions(extension.GFM),
goldmark.WithParserOptions(
parser.WithAutoHeadingID(), // generate heading IDs for content navigation
),
goldmark.WithRendererOptions(
html.WithXHTML(),
html.WithUnsafe(), // allow inline HTML
),
)
ctx := parser.NewContext(
parser.WithIDs(&IDGenerator{}), // register custom ID generator
)
var buf bytes.Buffer
if err := md.Convert(markdown, &buf, parser.WithContext(ctx)); err != nil {
return nil, err
}
return buf.Bytes(), nil
}
// IDGenerator for goldmark to provide IDs more similar to GitHub's IDs on markdown parsing
type IDGenerator struct {
used map[string]bool
}
// Generate an ID
func (g *IDGenerator) Generate(value []byte, _ ast.NodeKind) []byte {
return []byte(slug.Generate(string(value)))
}
// Put an ID to the list of already used IDs
func (g *IDGenerator) Put(value []byte) {
g.used[util.BytesToReadOnlyString(value)] = true
}
================================================
FILE: pkg/markdown/convert_test.go
================================================
package markdown
import (
"strings"
"testing"
)
func TestToHTML(t *testing.T) {
input := []byte(
`## some headline
followed by some paragraph with [a link](https://example.local)
and some list:
- first
- second
- nested on second level
- nested on third level
- ~~strikethrough~~
- yet another second level item, **but** with a [a link](https://example.local)
- end
### h3 headline/header
embedded HTML is allowed
`,
)
expected := []byte(
`{{.Title}} - Awesome Go
================================================
FILE: tmpl/index.tmpl.html
================================================
Awesome Go - A curated list of awesome Go frameworks, libraries and software
================================================
FILE: tmpl/project.tmpl.html
================================================
{{.Title}} - {{.CategoryTitle}} - Awesome Go
================================================
FILE: tmpl/robots.txt
================================================
User-Agent: *
Allow: /
Sitemap: https://awesome-go.com/sitemap.xml
================================================
FILE: tmpl/sitemap.tmpl.xml
================================================
https://awesome-go.com/
{{now}}
daily
1.0
{{range .Categories}}
https://awesome-go.com/{{.Slug}}/
{{now}}
weekly
0.8
{{end}}
{{range .Projects}}
https://awesome-go.com/{{.CategorySlug}}/{{.Slug}}/
{{now}}
weekly
0.6
{{end}}
some headline
followed by some paragraph with a link and some list:
h3 headline/header
`, ) got, err := ToHTML(input) if err != nil { t.Errorf("ToHTML() error = %v", err) return } if strings.TrimSpace(string(got)) != strings.TrimSpace(string(expected)) { t.Errorf("ToHTML() got = %v, want %v", string(got), string(expected)) } } ================================================ FILE: pkg/slug/generator.go ================================================ package slug import ( "strings" "github.com/avelino/slugify" ) // Generate slugs similar to GitHub's slugs on markdown parsing func Generate(text string) string { // FIXME: this is should be like regexp.Replace(`[^-a-zA-Z\d]+`, ``) s := strings.ReplaceAll(text, "/", "") return slugify.Slugify(strings.TrimSpace(s)) } ================================================ FILE: pkg/slug/generator_test.go ================================================ package slug import "testing" func TestGenerate(t *testing.T) { tests := []struct { name string input string expected string }{ { name: "with spaces", input: "some string with spaces", expected: "some-string-with-spaces", }, { name: "with out any non-literal chars", input: "inputstring", expected: "inputstring", }, { name: "with whitespace prefix and suffix", input: " inputstring ", expected: "inputstring", }, { name: "a mix of special characters", input: " an input string (with.special/chars,such_as:§\\?$/§&!) ", expected: "an-input-string-with-specialchars-such-as", }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { if got := Generate(tt.input); got != tt.expected { t.Errorf("Generate() = %v, want %v", got, tt.expected) } }) } } ================================================ FILE: stale_repositories_test.go ================================================ package main import ( "bytes" "context" "encoding/json" "fmt" "log" "net/http" "os" "regexp" "strings" "testing" "text/template" "time" "github.com/PuerkitoBio/goquery" "golang.org/x/oauth2" ) const issueTemplateContent = ` {{range .}} - [ ] {{.}} {{end}} ` var issueTemplate = template.Must(template.New("issue").Parse(issueTemplateContent)) // FIXME: use official github client var reGithubRepo = regexp.MustCompile("https://github.com/([a-zA-Z0-9-._]+)/([a-zA-Z0-9-._]+)$") var githubGETREPO = "https://api.github.com/repos%s" var githubGETCOMMITS = "https://api.github.com/repos%s/commits" var githubPOSTISSUES = "https://api.github.com/repos/avelino/awesome-go/issues" // FIXME: use https var awesomeGoGETISSUES = "http://api.github.com/repos/avelino/awesome-go/issues" //only returns open issues // FIXME: variable has type Duration, but contains a number. we should use // // time.Hour * ... or change type of variable var numberOfYears time.Duration = 1 var timeNow = time.Now() var issueTitle = fmt.Sprintf("Investigate repositories with more than 1 year without update - %s", timeNow.Format(time.DateOnly)) const deadLinkMessage = " this repository might no longer exist! (status code >= 400 returned)" const movedPermanently = " status code 301 received" const status302 = " status code 302 received" const archived = " repository has been archived" // LIMIT specifies the max number of repositories that are added in a single run of the script var LIMIT = 10 var ctr = 0 type tokenSource struct { AccessToken string } type issue struct { Title string `json:"title"` Body string `json:"body"` } func (t *tokenSource) Token() (*oauth2.Token, error) { return &oauth2.Token{ AccessToken: t.AccessToken, }, nil } func getRepositoriesFromBody(body string) []string { links := strings.Split(body, "- ") for i, link := range links { link = strings.ReplaceAll(link, "\r", "") link = strings.ReplaceAll(link, "[ ]", "") link = strings.ReplaceAll(link, "[x]", "") link = strings.ReplaceAll(link, " ", "") link = strings.ReplaceAll(link, "\n", "") link = strings.ReplaceAll(link, deadLinkMessage, "") link = strings.ReplaceAll(link, movedPermanently, "") link = strings.ReplaceAll(link, status302, "") link = strings.ReplaceAll(link, archived, "") links[i] = link } return links } func generateIssueBody(t *testing.T, repositories []string) (string, error) { t.Helper() buf := bytes.NewBuffer(nil) err := issueTemplate.Execute(buf, repositories) requireNoErr(t, err, "Failed to generate template") return buf.String(), nil } func createIssue(t *testing.T, staleRepos []string, client *http.Client) { t.Helper() if len(staleRepos) == 0 { log.Print("NO STALE REPOSITORIES") return } body, err := generateIssueBody(t, staleRepos) requireNoErr(t, err, "failed to generate issue body") newIssue := &issue{ Title: issueTitle, Body: body, } buf := bytes.NewBuffer(nil) requireNoErr(t, json.NewEncoder(buf).Encode(newIssue), "failed to encode json req") req, err := http.NewRequest(http.MethodPost, githubPOSTISSUES, buf) requireNoErr(t, err, "failed to create request") _, roundTripErr := client.Do(req) requireNoErr(t, roundTripErr, "failed to send request") } func getAllFlaggedRepositories(t *testing.T, client *http.Client) map[string]bool { t.Helper() req, err := http.NewRequest(http.MethodGet, awesomeGoGETISSUES, nil) requireNoErr(t, err, "failed to create request") res, err := client.Do(req) requireNoErr(t, err, "failed to send request") defer res.Body.Close() var issues []issue requireNoErr(t, json.NewDecoder(res.Body).Decode(&issues), "failed to unmarshal response") addressedRepositories := make(map[string]bool) for _, issue := range issues { if issue.Title != issueTitle { continue } repos := getRepositoriesFromBody(issue.Body) for _, repo := range repos { addressedRepositories[repo] = true } } return addressedRepositories } func checkRepoAvailability(toRun bool, href string, client *http.Client) ([]string, bool) { if !toRun { return nil, false } ownerRepo := strings.ReplaceAll(href, "https://github.com", "") apiCall := fmt.Sprintf(githubGETREPO, ownerRepo) req, err := http.NewRequest(http.MethodGet, apiCall, nil) if err != nil { log.Printf("Failed at repository %s\n", href) return nil, false } resp, err := client.Do(req) if err != nil { log.Printf("Failed at repository %s\n", href) return nil, false } defer resp.Body.Close() var repoResp struct { Archived bool `json:"archived"` } if err := json.NewDecoder(resp.Body).Decode(&repoResp); err != nil { return nil, false } var isRepoAdded bool var warnings []string if resp.StatusCode == http.StatusMovedPermanently { warnings = append(warnings, href+movedPermanently) log.Printf("%s returned %d", href, resp.StatusCode) isRepoAdded = true } if resp.StatusCode == http.StatusFound && !isRepoAdded { warnings = append(warnings, href+status302) log.Printf("%s returned %d", href, resp.StatusCode) isRepoAdded = true } if resp.StatusCode >= http.StatusBadRequest && !isRepoAdded { warnings = append(warnings, href+deadLinkMessage) log.Printf("%s might not exist!", href) isRepoAdded = true } if repoResp.Archived && !isRepoAdded { warnings = append(warnings, href+archived) log.Printf("%s is archived!", href) isRepoAdded = true } // FIXME: expression `(len(warnings) > 0) == isRepoAdded` is always true. return warnings, isRepoAdded } func checkRepoCommitActivity(toRun bool, href string, client *http.Client) ([]string, bool) { if !toRun { return nil, false } ownerRepo := strings.ReplaceAll(href, "https://github.com", "") apiCall := fmt.Sprintf(githubGETCOMMITS, ownerRepo) req, err := http.NewRequest(http.MethodGet, apiCall, nil) if err != nil { log.Printf("Failed at repository %s\n", href) return nil, false } since := timeNow.Add(-1 * 365 * 24 * numberOfYears * time.Hour) sinceQuery := since.Format(time.RFC3339) q := req.URL.Query() q.Add("since", sinceQuery) req.URL.RawQuery = q.Encode() resp, err := client.Do(req) if err != nil { log.Printf("Failed at repository %s\n", href) return nil, false } defer resp.Body.Close() var respObj []map[string]interface{} // FIXME: handle error in all that cases if err := json.NewDecoder(resp.Body).Decode(&respObj); err != nil { return nil, false } var warnings []string var isRepoAdded bool isAged := len(respObj) == 0 if isAged { log.Printf("%s has not had a commit in a while", href) warnings = append(warnings, href) isRepoAdded = true } // FIXME: expression `(len(warnings) > 0) == isRepoAdded` is always true. return warnings, isRepoAdded } func TestStaleRepository(t *testing.T) { doc := goqueryFromReadme(t) oauth := os.Getenv("OAUTH_TOKEN") client := &http.Client{ Transport: &http.Transport{}, } if oauth == "" { log.Print("No oauth token found. Using unauthenticated client ...") } else { tokenSource := &tokenSource{ AccessToken: oauth, } client = oauth2.NewClient(context.Background(), tokenSource) } // FIXME: return addressedRepositories, no need to pass addressedRepositories := getAllFlaggedRepositories(t, client) var staleRepos []string doc. Find("body li > a:first-child"). EachWithBreak(func(_ int, s *goquery.Selection) bool { href, ok := s.Attr("href") if !ok { log.Println("expected to have href") return true } if ctr >= LIMIT && LIMIT != -1 { log.Print("Max number of issues created") return false } if _, issueExists := addressedRepositories[href]; issueExists { log.Printf("issue already exists for %s\n", href) return true } if !reGithubRepo.MatchString(href) { log.Printf("%s non-github repo not currently handled", href) } // FIXME: this is `or` expres24sion. Probably we need `and`? warnings, isRepoAdded := checkRepoAvailability(true, href, client) staleRepos = append(staleRepos, warnings...) warnings, isRepoAdded = checkRepoCommitActivity(!isRepoAdded, href, client) staleRepos = append(staleRepos, warnings...) if isRepoAdded { ctr++ } return true }) createIssue(t, staleRepos, client) } ================================================ FILE: tmpl/assets/awesome-go.css ================================================ /* ========================================================================== Awesome Go — Design System v2 ========================================================================== */ /* --- 1. Variables -------------------------------------------------------- */ :root { /* Colors — Light (default) */ --color-bg: #ffffff; --color-bg-subtle: #f8f9fa; --color-surface: #f1f3f5; --color-surface-hover: #e9ecef; --color-border: #dee2e6; --color-border-subtle: #e9ecef; --color-text: #111827; --color-text-secondary: #4b5563; --color-text-muted: #6b7280; --color-accent: #00ADD8; --color-accent-hover: #0891b2; --color-accent-soft: rgba(0, 173, 216, 0.08); --color-accent-glow: rgba(0, 173, 216, 0.15); --color-header-bg: rgba(255, 255, 255, 0.85); --color-header-border: rgba(0, 0, 0, 0.06); --color-code-bg: #f1f3f5; --color-code-text: #1e293b; --color-link-visited: #0e7490; --color-hero-gradient-1: rgba(0, 173, 216, 0.06); --color-hero-gradient-2: rgba(99, 102, 241, 0.04); --color-hero-gradient-3: transparent; --color-card-shadow: rgba(0, 0, 0, 0.04); --color-card-shadow-hover: rgba(0, 0, 0, 0.08); /* Typography */ --font-sans: "Inter", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif; --font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace; /* Spacing */ --space-xs: 0.25rem; --space-sm: 0.5rem; --space-md: 1rem; --space-lg: 1.5rem; --space-xl: 2rem; --space-2xl: 3rem; --space-3xl: 4rem; --space-4xl: 6rem; /* Layout */ --max-width: 900px; --header-height: 60px; /* Radius */ --radius-sm: 6px; --radius-md: 10px; --radius-lg: 16px; --radius-full: 9999px; /* Transitions */ --transition-fast: 150ms ease; --transition-base: 200ms ease; --transition-slow: 300ms ease; } @media (prefers-color-scheme: dark) { :root { --color-bg: #0a0a0b; --color-bg-subtle: #111114; --color-surface: #18181b; --color-surface-hover: #1f1f23; --color-border: #27272a; --color-border-subtle: #1e1e21; --color-text: #f4f4f5; --color-text-secondary: #a1a1aa; --color-text-muted: #71717a; --color-accent: #22d3ee; --color-accent-hover: #67e8f9; --color-accent-soft: rgba(34, 211, 238, 0.08); --color-accent-glow: rgba(34, 211, 238, 0.12); --color-header-bg: rgba(10, 10, 11, 0.85); --color-header-border: rgba(255, 255, 255, 0.06); --color-code-bg: #1e1e21; --color-code-text: #d4d4d8; --color-link-visited: #67e8f9; --color-hero-gradient-1: rgba(34, 211, 238, 0.06); --color-hero-gradient-2: rgba(99, 102, 241, 0.04); --color-hero-gradient-3: transparent; --color-card-shadow: rgba(0, 0, 0, 0.2); --color-card-shadow-hover: rgba(0, 0, 0, 0.4); } } /* --- 2. Reset ------------------------------------------------------------ */ *, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; } /* --- 3. Base ------------------------------------------------------------- */ html { color-scheme: light dark; -webkit-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; scroll-padding-top: calc(var(--header-height) + var(--space-xl)); scroll-behavior: smooth; } body { font-family: var(--font-sans); font-size: 16px; line-height: 1.7; color: var(--color-text); background-color: var(--color-bg); min-height: 100vh; } ::selection { background-color: var(--color-accent); color: #fff; } /* --- 4. Typography ------------------------------------------------------- */ h1, h2, h3, h4, h5, h6 { font-weight: 700; line-height: 1.3; color: var(--color-text); letter-spacing: -0.02em; } h1 { font-size: 2.25rem; margin-top: var(--space-3xl); margin-bottom: var(--space-lg); } h2 { font-size: 1.5rem; margin-top: var(--space-3xl); margin-bottom: var(--space-md); padding-bottom: var(--space-md); border-bottom: 2px solid var(--color-border-subtle); position: relative; } h2::after { content: ""; position: absolute; bottom: -2px; left: 0; width: 48px; height: 2px; background: var(--color-accent); border-radius: 1px; } h3 { font-size: 1.2rem; margin-top: var(--space-2xl); margin-bottom: var(--space-sm); } h4 { font-size: 1.05rem; margin-top: var(--space-xl); margin-bottom: var(--space-sm); } h5 { font-size: 1rem; font-weight: 600; margin-top: var(--space-lg); margin-bottom: var(--space-sm); } h6 { font-size: 0.875rem; font-weight: 600; color: var(--color-text-secondary); margin-top: var(--space-lg); margin-bottom: var(--space-sm); } p { margin-bottom: var(--space-md); color: var(--color-text-secondary); line-height: 1.75; } blockquote { border-left: 3px solid var(--color-accent); padding: var(--space-md) var(--space-lg); margin: var(--space-xl) 0; background-color: var(--color-accent-soft); border-radius: 0 var(--radius-md) var(--radius-md) 0; color: var(--color-text-secondary); font-style: italic; } code { font-family: var(--font-mono); font-size: 0.85em; background-color: var(--color-code-bg); color: var(--color-code-text); padding: 0.2em 0.45em; border-radius: var(--radius-sm); border: 1px solid var(--color-border-subtle); } pre { background-color: var(--color-code-bg); border-radius: var(--radius-md); border: 1px solid var(--color-border-subtle); padding: var(--space-lg); overflow-x: auto; margin: var(--space-xl) 0; } pre code { background: none; padding: 0; border: none; font-size: 0.875rem; } hr { border: none; border-top: 1px solid var(--color-border); margin: var(--space-3xl) 0; } /* --- 5. Links ------------------------------------------------------------ */ a { color: var(--color-accent); text-decoration: none; transition: color var(--transition-fast), opacity var(--transition-fast); } a:hover { color: var(--color-accent-hover); } a:visited { color: var(--color-link-visited); } /* --- 6. Lists ------------------------------------------------------------ */ ul, ol { padding-left: var(--space-xl); margin-bottom: var(--space-md); } li { margin-bottom: var(--space-xs); line-height: 1.75; } li > ul, li > ol { margin-top: var(--space-xs); margin-bottom: 0; } /* Style the "back to top" links */ #content > p > strong > a[href="#contents"] { display: inline-flex; align-items: center; gap: var(--space-xs); font-size: 0.8125rem; font-weight: 500; color: var(--color-text-muted); padding: var(--space-xs) var(--space-md); border-radius: var(--radius-full); background-color: var(--color-surface); border: 1px solid var(--color-border-subtle); transition: all var(--transition-fast); text-decoration: none; } #content > p > strong > a[href="#contents"]:hover { color: var(--color-accent); background-color: var(--color-accent-soft); border-color: var(--color-accent); } /* --- 7. Tables (sponsor table) ------------------------------------------- */ table { width: 100%; border-collapse: separate; border-spacing: 0; margin: var(--space-xl) 0; font-size: 0.9375rem; border-radius: var(--radius-md); overflow: hidden; border: 1px solid var(--color-border); } th, td { text-align: left; padding: var(--space-sm) var(--space-md); } th { font-weight: 600; color: var(--color-text); background-color: var(--color-surface); } td { border-top: 1px solid var(--color-border-subtle); } /* --- 8. Images ----------------------------------------------------------- */ img { max-width: 100%; height: auto; display: inline-block; vertical-align: middle; } /* --- 9. Details / Summary (TOC) ------------------------------------------ */ details { margin: var(--space-xl) 0; border: 1px solid var(--color-border); border-radius: var(--radius-lg); padding: 0; background-color: var(--color-bg-subtle); overflow: hidden; transition: border-color var(--transition-base); } details:hover { border-color: var(--color-accent); } details[open] { border-color: var(--color-accent); box-shadow: 0 0 0 1px var(--color-accent-glow); } summary { cursor: pointer; font-weight: 600; font-size: 1rem; color: var(--color-text); list-style: none; display: flex; align-items: center; gap: var(--space-sm); padding: var(--space-lg) var(--space-xl); transition: background-color var(--transition-fast); user-select: none; } summary:hover { background-color: var(--color-surface); } summary::-webkit-details-marker { display: none; } summary::before { content: ""; width: 20px; height: 20px; flex-shrink: 0; background-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 20 20' fill='%236b7280'%3E%3Cpath d='M7.21 14.77a.75.75 0 01.02-1.06L11.168 10 7.23 6.29a.75.75 0 111.04-1.08l4.5 4.25a.75.75 0 010 1.08l-4.5 4.25a.75.75 0 01-1.06-.02z'/%3E%3C/svg%3E"); background-size: contain; background-repeat: no-repeat; transition: transform var(--transition-base); } details[open] > summary::before { transform: rotate(90deg); } details[open] > summary { border-bottom: 1px solid var(--color-border-subtle); } details > ul, details > ul > li > ul { padding: var(--space-md) var(--space-xl) var(--space-md) var(--space-3xl); } details > ul > li > ul > li > ul { padding: var(--space-xs) 0 var(--space-xs) var(--space-lg); } details li a { display: inline-block; padding: 2px 0; font-weight: 500; font-size: 0.9375rem; transition: color var(--transition-fast), transform var(--transition-fast); } details li a:hover { transform: translateX(2px); } /* --- 10. Site Header ----------------------------------------------------- */ .site-header { position: sticky; top: 0; z-index: 100; height: var(--header-height); background-color: var(--color-header-bg); backdrop-filter: saturate(180%) blur(16px); -webkit-backdrop-filter: saturate(180%) blur(16px); border-bottom: 1px solid var(--color-header-border); display: flex; align-items: center; justify-content: center; } .header-inner { width: 100%; max-width: var(--max-width); padding: 0 var(--space-xl); display: flex; align-items: center; justify-content: space-between; } .header-brand { display: flex; align-items: center; gap: 10px; font-weight: 700; font-size: 1.125rem; color: var(--color-text); text-decoration: none; letter-spacing: -0.02em; } .header-brand:hover { color: var(--color-text); text-decoration: none; } .header-brand:visited { color: var(--color-text); } .header-brand img { width: 30px; height: 30px; } .header-nav { display: flex; align-items: center; gap: var(--space-xs); } .header-nav a { font-size: 0.875rem; font-weight: 500; color: var(--color-text-secondary); text-decoration: none; padding: var(--space-xs) var(--space-md); border-radius: var(--radius-sm); transition: color var(--transition-fast), background-color var(--transition-fast); } .header-nav a:hover { color: var(--color-text); background-color: var(--color-surface); text-decoration: none; } .header-nav a:visited { color: var(--color-text-secondary); } .github-link { display: inline-flex; align-items: center; gap: 6px; } .github-link svg { width: 18px; height: 18px; fill: currentColor; } /* --- 11. Hero ------------------------------------------------------------ */ .hero { background: radial-gradient(ellipse 80% 60% at 50% 0%, var(--color-hero-gradient-1) 0%, var(--color-hero-gradient-3) 100%), radial-gradient(ellipse 60% 50% at 80% 20%, var(--color-hero-gradient-2) 0%, var(--color-hero-gradient-3) 100%); padding: var(--space-4xl) var(--space-xl) var(--space-3xl); text-align: center; position: relative; overflow: hidden; } .hero::before { content: ""; position: absolute; top: 0; left: 50%; transform: translateX(-50%); width: 600px; height: 600px; background: radial-gradient(circle, var(--color-accent-glow) 0%, transparent 70%); pointer-events: none; opacity: 0.5; } .hero-content { position: relative; max-width: var(--max-width); margin: 0 auto; } .hero-logo { display: block; width: 200px; height: auto; margin: 0 auto var(--space-xl); filter: drop-shadow(0 4px 24px var(--color-accent-glow)); } .hero-title { font-size: 3rem; font-weight: 800; letter-spacing: -0.04em; margin: 0 0 var(--space-md); line-height: 1.1; background: linear-gradient(135deg, var(--color-text) 0%, var(--color-text-secondary) 100%); -webkit-background-clip: text; background-clip: text; } .hero-description { font-size: 1.2rem; color: var(--color-text-muted); max-width: 560px; margin: 0 auto var(--space-xl); line-height: 1.6; } .hero-badges { display: flex; gap: var(--space-sm); justify-content: center; flex-wrap: wrap; } .hero-badges img { height: 22px; width: auto; transition: opacity var(--transition-fast); } .hero-badges img:hover { opacity: 0.8; } /* --- 12. Content --------------------------------------------------------- */ #content { width: 100%; max-width: var(--max-width); margin: 0 auto; padding: var(--space-xl) var(--space-xl) var(--space-4xl); } /* Style category list items in main content */ #content > ul > li { padding: var(--space-xs) 0; line-height: 1.75; } /* --- 13. Category Page --------------------------------------------------- */ .category-hero { background: radial-gradient(ellipse 70% 50% at 30% 0%, var(--color-hero-gradient-1) 0%, var(--color-hero-gradient-3) 100%), radial-gradient(ellipse 50% 40% at 70% 10%, var(--color-hero-gradient-2) 0%, var(--color-hero-gradient-3) 100%); padding: var(--space-3xl) var(--space-xl) var(--space-2xl); } .category-hero-inner { max-width: var(--max-width); margin: 0 auto; } .breadcrumb { display: flex; align-items: center; gap: var(--space-sm); font-size: 0.8125rem; color: var(--color-text-muted); margin-bottom: var(--space-xl); } .breadcrumb a { color: var(--color-text-muted); transition: color var(--transition-fast); } .breadcrumb a:hover { color: var(--color-accent); } .breadcrumb a:visited { color: var(--color-text-muted); } .breadcrumb-separator { color: var(--color-border); user-select: none; font-size: 0.75rem; } .category-header h1 { margin: 0 0 var(--space-sm); font-size: 2.25rem; letter-spacing: -0.03em; } .category-header p { font-size: 1.1rem; color: var(--color-text-secondary); margin: 0; line-height: 1.6; } .category-count { display: inline-flex; align-items: center; gap: var(--space-xs); font-size: 0.8125rem; font-weight: 500; color: var(--color-accent); background-color: var(--color-accent-soft); padding: var(--space-xs) var(--space-md); border-radius: var(--radius-full); margin-top: var(--space-md); } .category-list { list-style: none; padding-left: 0; margin: 0; } .category-list li { padding: var(--space-lg) 0; border-bottom: 1px solid var(--color-border-subtle); line-height: 1.7; transition: background-color var(--transition-fast); } .category-list li:first-child { padding-top: 0; } .category-list li:last-child { border-bottom: none; } .category-list li a { font-weight: 500; color: var(--color-text); transition: color var(--transition-fast); } .category-list li a:hover { color: var(--color-accent); } .category-list li a:visited { color: var(--color-text); } .back-link { display: inline-flex; align-items: center; gap: var(--space-sm); margin-top: var(--space-3xl); font-size: 0.875rem; font-weight: 600; color: var(--color-text-muted); padding: var(--space-sm) var(--space-lg); border-radius: var(--radius-full); border: 1px solid var(--color-border); background-color: var(--color-bg); transition: all var(--transition-base); } .back-link:hover { color: var(--color-accent); border-color: var(--color-accent); background-color: var(--color-accent-soft); transform: translateX(-2px); } .back-link:visited { color: var(--color-text-muted); } /* --- 14. Project Page ---------------------------------------------------- */ .project-hero { background: radial-gradient(ellipse 70% 50% at 30% 0%, var(--color-hero-gradient-1) 0%, var(--color-hero-gradient-3) 100%), radial-gradient(ellipse 50% 40% at 70% 10%, var(--color-hero-gradient-2) 0%, var(--color-hero-gradient-3) 100%); padding: var(--space-3xl) var(--space-xl) var(--space-2xl); } .project-hero-inner { max-width: var(--max-width); margin: 0 auto; } .project-header h1 { margin: 0 0 var(--space-sm); font-size: 2.25rem; letter-spacing: -0.03em; } .project-header p { font-size: 1.1rem; color: var(--color-text-secondary); margin: 0 0 var(--space-lg); line-height: 1.6; } .repo-link { display: inline-flex; align-items: center; gap: var(--space-sm); font-size: 0.875rem; font-weight: 600; color: #fff; background-color: var(--color-accent); padding: var(--space-sm) var(--space-lg); border-radius: var(--radius-full); transition: all var(--transition-base); text-decoration: none; } .repo-link:hover { background-color: var(--color-accent-hover); color: #fff; transform: translateY(-1px); box-shadow: 0 4px 12px var(--color-accent-glow); } .repo-link:visited { color: #fff; } .repo-link svg { flex-shrink: 0; } .project-meta { display: grid; grid-template-columns: repeat(auto-fit, minmax(140px, 1fr)); gap: var(--space-md); margin-bottom: var(--space-2xl); } .meta-card { display: flex; flex-direction: column; gap: var(--space-xs); padding: var(--space-lg); background-color: var(--color-surface); border: 1px solid var(--color-border-subtle); border-radius: var(--radius-md); transition: border-color var(--transition-fast), box-shadow var(--transition-fast); } .meta-card:hover { border-color: var(--color-accent); box-shadow: 0 2px 8px var(--color-card-shadow); } .meta-value { font-size: 1.25rem; font-weight: 700; color: var(--color-text); letter-spacing: -0.02em; } .meta-label { font-size: 0.75rem; font-weight: 500; color: var(--color-text-muted); text-transform: uppercase; letter-spacing: 0.05em; } .project-topics { display: flex; flex-wrap: wrap; gap: var(--space-sm); margin-bottom: var(--space-2xl); } .topic-tag { display: inline-block; font-size: 0.8125rem; font-weight: 500; color: var(--color-accent); background-color: var(--color-accent-soft); padding: var(--space-xs) var(--space-md); border-radius: var(--radius-full); border: 1px solid transparent; transition: all var(--transition-fast); } .topic-tag:hover { border-color: var(--color-accent); background-color: var(--color-accent-glow); } .related-projects { margin-top: var(--space-3xl); padding-top: var(--space-2xl); border-top: 2px solid var(--color-border-subtle); } .related-projects h2 { margin-top: 0; } /* --- 15. Footer ---------------------------------------------------------- */ .site-footer { border-top: 1px solid var(--color-border); background-color: var(--color-bg-subtle); padding: var(--space-3xl) var(--space-xl); } .footer-inner { max-width: var(--max-width); margin: 0 auto; display: flex; flex-direction: column; align-items: center; gap: var(--space-lg); } .footer-links { display: flex; gap: var(--space-sm); flex-wrap: wrap; justify-content: center; } .footer-links a { font-size: 0.8125rem; font-weight: 500; color: var(--color-text-muted); padding: var(--space-xs) var(--space-md); border-radius: var(--radius-sm); transition: color var(--transition-fast), background-color var(--transition-fast); } .footer-links a:hover { color: var(--color-accent); background-color: var(--color-surface); } .footer-links a:visited { color: var(--color-text-muted); } .footer-credit { font-size: 0.8125rem; color: var(--color-text-muted); } .footer-credit a { color: var(--color-text-muted); text-decoration: underline; text-underline-offset: 2px; } .footer-credit a:hover { color: var(--color-accent); } .footer-credit a:visited { color: var(--color-text-muted); } /* --- 16. Responsive ------------------------------------------------------ */ @media (max-width: 768px) { :root { --space-xl: 1.5rem; --space-2xl: 2rem; --space-3xl: 2.5rem; --space-4xl: 3.5rem; } h1 { font-size: 1.75rem; } h2 { font-size: 1.35rem; } .hero { padding: var(--space-3xl) var(--space-md) var(--space-2xl); } .hero-title { font-size: 2.25rem; } .hero-logo { width: 140px; } .hero-description { font-size: 1.05rem; } .header-inner { padding: 0 var(--space-md); } .category-header h1, .project-header h1 { font-size: 1.75rem; } .project-meta { grid-template-columns: repeat(2, 1fr); } summary { padding: var(--space-md) var(--space-lg); } details > ul, details > ul > li > ul { padding: var(--space-sm) var(--space-lg) var(--space-sm) var(--space-2xl); } } @media (max-width: 480px) { body { font-size: 15px; } h1 { font-size: 1.5rem; } h2 { font-size: 1.2rem; } #content { padding: var(--space-md) var(--space-md) var(--space-2xl); } .hero-title { font-size: 1.75rem; } .hero-logo { width: 120px; } .hero-description { font-size: 0.95rem; } .hero-badges { gap: var(--space-xs); } .hero-badges img { height: 18px; } .header-nav a { font-size: 0.8125rem; padding: var(--space-xs) var(--space-sm); } .category-header h1, .project-header h1 { font-size: 1.5rem; } .project-meta { grid-template-columns: 1fr 1fr; } table { font-size: 0.875rem; } th, td { padding: var(--space-xs) var(--space-sm); } } /* --- 17. Print ----------------------------------------------------------- */ @media print { .site-header, .site-footer, .hero::before { display: none; } body { color: #000; background: #fff; } .hero { background: none; padding: var(--space-xl) 0; } #content { max-width: 100%; padding: 0; } a { color: #000; text-decoration: underline; } a[href]::after { content: " (" attr(href) ")"; font-size: 0.8em; color: #666; } a[href^="#"]::after, a[href^="javascript:"]::after { content: ""; } } ================================================ FILE: tmpl/assets/favicon/manifest.json ================================================ { "name": "Awesome Go", "short_name": "Awesome-Go", "icons": [ { "src": "./android-chrome-192x192.png", "sizes": "192x192", "type": "image/png" }, { "src": "./android-chrome-512x512.png", "sizes": "512x512", "type": "image/png" } ], "theme_color": "#ffffff", "background_color": "#ffffff", "display": "standalone" } ================================================ FILE: tmpl/assets/fonts/firasans.css ================================================ @font-face { font-family: 'Fira Sans'; src: local('Fira Sans ExtraLight'), local('FiraSans-ExtraLight'), url('/assets/fonts/firasansextralight.woff2') format('woff2'), url('/assets/fonts/firasansextralight.woff') format('woff'), url('/assets/fonts/firasansextralight.ttf') format('truetype'); font-weight: 100; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans ExtraLight Italic'), local('FiraSans-ExtraLightItalic'), url('/assets/fonts/firasansextralightitalic.woff2') format('woff2'), url('/assets/fonts/firasansextralightitalic.woff') format('woff'), url('/assets/fonts/firasansextralightitalic.ttf') format('truetype'); font-weight: 100; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Light'), local('FiraSans-Light'), url('/assets/fonts/firasanslight.woff2') format('woff2'), url('/assets/fonts/firasanslight.woff') format('woff'), url('/assets/fonts/firasanslight.ttf') format('truetype'); font-weight: 200; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Light Italic'), local('FiraSans-LightItalic'), url('/assets/fonts/firasanslightitalic.woff2') format('woff2'), url('/assets/fonts/firasanslightitalic.woff') format('woff'), url('/assets/fonts/firasanslightitalic.ttf') format('truetype'); font-weight: 200; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Book'), local('FiraSans-Book'), url('/assets/fonts/firasansbook.woff2') format('woff2'), url('/assets/fonts/firasansbook.woff') format('woff'), url('/assets/fonts/firasansbook.ttf') format('truetype'); font-weight: 300; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Book Italic'), local('FiraSans-BookItalic'), url('/assets/fonts/firasansbookitalic.woff2') format('woff2'), url('/assets/fonts/firasansbookitalic.woff') format('woff'), url('/assets/fonts/firasansbookitalic.ttf') format('truetype'); font-weight: 300; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans'), local('FiraSans-Regular'), url('/assets/fonts/firasans.woff2') format('woff2'), url('/assets/fonts/firasans.woff') format('woff'), url('/assets/fonts/firasans.ttf') format('truetype'); font-weight: 400; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Italic'), local('FiraSans-Italic'), url('/assets/fonts/firasansitalic.woff2') format('woff2'), url('/assets/fonts/firasansitalic.woff') format('woff'), url('/assets/fonts/firasansitalic.ttf') format('truetype'); font-weight: 400; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Medium'), local('FiraSans-Medium'), url('/assets/fonts/firasansmedium.woff2') format('woff2'), url('/assets/fonts/firasansmedium.woff') format('woff'), url('/assets/fonts/firasansmedium.ttf') format('truetype'); font-weight: 500; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Medium Italic'), local('FiraSans-MediumItalic'), url('/assets/fonts/firasansmediumitalic.woff2') format('woff2'), url('/assets/fonts/firasansmediumitalic.woff') format('woff'), url('/assets/fonts/firasansmediumitalic.ttf') format('truetype'); font-weight: 500; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans SemiBold'), local('FiraSans-SemiBold'), url('/assets/fonts/firasanssemibold.woff2') format('woff2'), url('/assets/fonts/firasanssemibold.woff') format('woff'), url('/assets/fonts/firasanssemibold.ttf') format('truetype'); font-weight: 600; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans SemiBold Italic'), local('FiraSans-SemiBoldItalic'), url('/assets/fonts/firasanssemibolditalic.woff2') format('woff2'), url('/assets/fonts/firasanssemibolditalic.woff') format('woff'), url('/assets/fonts/firasanssemibolditalic.ttf') format('truetype'); font-weight: 600; font-style: italic; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Bold'), local('FiraSans-Bold'), url('/assets/fonts/firasansbold.woff2') format('woff2'), url('/assets/fonts/firasansbold.woff') format('woff'), url('/assets/fonts/firasansbold.ttf') format('truetype'); font-weight: 700; font-style: normal; } @font-face { font-family: 'Fira Sans'; src: local('Fira Sans Bold Italic'), local('FiraSans-BoldItalic'), url('/assets/fonts/firasansbolditalic.woff2') format('woff2'), url('/assets/fonts/firasansbolditalic.woff') format('woff'), url('/assets/fonts/firasansbolditalic.ttf') format('truetype'); font-weight: 700; font-style: italic; } ================================================ FILE: tmpl/assets/normalize.css ================================================ /*! normalize.css v3.0.1 | MIT License | git.io/normalize */ /** * 1. Set default font family to sans-serif. * 2. Prevent iOS text size adjust after orientation change, without disabling * user zoom. */ html { font-family: sans-serif; /* 1 */ -ms-text-size-adjust: 100%; /* 2 */ -webkit-text-size-adjust: 100%; /* 2 */ } /** * Remove default margin. */ body { margin: 0; } /* HTML5 display definitions ========================================================================== */ /** * Correct `block` display not defined for any HTML5 element in IE 8/9. * Correct `block` display not defined for `details` or `summary` in IE 10/11 and Firefox. * Correct `block` display not defined for `main` in IE 11. */ article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { display: block; } /** * 1. Correct `inline-block` display not defined in IE 8/9. * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera. */ audio, canvas, progress, video { display: inline-block; /* 1 */ vertical-align: baseline; /* 2 */ } /** * Prevent modern browsers from displaying `audio` without controls. * Remove excess height in iOS 5 devices. */ audio:not([controls]) { display: none; height: 0; } /** * Address `[hidden]` styling not present in IE 8/9/10. * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22. */ [hidden], template { display: none; } /* Links ========================================================================== */ /** * Remove the gray background color from active links in IE 10. */ a { background: transparent; } /** * Improve readability when focused and also mouse hovered in all browsers. */ a:active, a:hover { outline: 0; } /* Text-level semantics ========================================================================== */ /** * Address styling not present in IE 8/9/10/11, Safari, and Chrome. */ abbr[title] { border-bottom: 1px dotted; } /** * Address style set to `bolder` in Firefox 4+, Safari, and Chrome. */ b, strong { font-weight: bold; } /** * Address styling not present in Safari and Chrome. */ dfn { font-style: italic; } /** * Address variable `h1` font-size and margin within `section` and `article` * contexts in Firefox 4+, Safari, and Chrome. */ h1 { font-size: 2em; margin: 0.67em 0; } /** * Address styling not present in IE 8/9. */ mark { background: #ff0; color: #000; } /** * Address inconsistent and variable font size in all browsers. */ small { font-size: 80%; } /** * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline; } sup { top: -0.5em; } sub { bottom: -0.25em; } /* Embedded content ========================================================================== */ /** * Remove border when inside `a` element in IE 8/9/10. */ img { border: 0; } /** * Correct overflow not hidden in IE 9/10/11. */ svg:not(:root) { overflow: hidden; } /* Grouping content ========================================================================== */ /** * Address margin not present in IE 8/9 and Safari. */ figure { margin: 1em 40px; } /** * Address differences between Firefox and other browsers. */ hr { -moz-box-sizing: content-box; box-sizing: content-box; height: 0; } /** * Contain overflow in all browsers. */ pre { overflow: auto; } /** * Address odd `em`-unit font size rendering in all browsers. */ code, kbd, pre, samp { font-family: monospace, monospace; font-size: 1em; } /* Forms ========================================================================== */ /** * Known limitation: by default, Chrome and Safari on OS X allow very limited * styling of `select`, unless a `border` property is set. */ /** * 1. Correct color not being inherited. * Known issue: affects color of disabled elements. * 2. Correct font properties not being inherited. * 3. Address margins set differently in Firefox 4+, Safari, and Chrome. */ button, input, optgroup, select, textarea { color: inherit; /* 1 */ font: inherit; /* 2 */ margin: 0; /* 3 */ } /** * Address `overflow` set to `hidden` in IE 8/9/10/11. */ button { overflow: visible; } /** * Address inconsistent `text-transform` inheritance for `button` and `select`. * All other form control elements do not inherit `text-transform` values. * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera. * Correct `select` style inheritance in Firefox. */ button, select { text-transform: none; } /** * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` * and `video` controls. * 2. Correct inability to style clickable `input` types in iOS. * 3. Improve usability and consistency of cursor style between image-type * `input` and others. */ button, html input[type="button"], /* 1 */ input[type="reset"], input[type="submit"] { -webkit-appearance: button; /* 2 */ cursor: pointer; /* 3 */ } /** * Re-set default cursor for disabled elements. */ button[disabled], html input[disabled] { cursor: default; } /** * Remove inner padding and border in Firefox 4+. */ button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0; } /** * Address Firefox 4+ setting `line-height` on `input` using `!important` in * the UA stylesheet. */ input { line-height: normal; } /** * It's recommended that you don't attempt to style these elements. * Firefox's implementation doesn't respect box-sizing, padding, or width. * * 1. Address box sizing set to `content-box` in IE 8/9/10. * 2. Remove excess padding in IE 8/9/10. */ input[type="checkbox"], input[type="radio"] { box-sizing: border-box; /* 1 */ padding: 0; /* 2 */ } /** * Fix the cursor style for Chrome's increment/decrement buttons. For certain * `font-size` values of the `input`, it causes the cursor style of the * decrement button to change from `default` to `text`. */ input[type="number"]::-webkit-inner-spin-button, input[type="number"]::-webkit-outer-spin-button { height: auto; } /** * 1. Address `appearance` set to `searchfield` in Safari and Chrome. * 2. Address `box-sizing` set to `border-box` in Safari and Chrome * (include `-moz` to future-proof). */ input[type="search"] { -webkit-appearance: textfield; /* 1 */ -moz-box-sizing: content-box; -webkit-box-sizing: content-box; /* 2 */ box-sizing: content-box; } /** * Remove inner padding and search cancel button in Safari and Chrome on OS X. * Safari (but not Chrome) clips the cancel button when the search input has * padding (and `textfield` appearance). */ input[type="search"]::-webkit-search-cancel-button, input[type="search"]::-webkit-search-decoration { -webkit-appearance: none; } /** * Define consistent border, margin, and padding. */ fieldset { border: 1px solid #c0c0c0; margin: 0 2px; padding: 0.35em 0.625em 0.75em; } /** * 1. Correct `color` not being inherited in IE 8/9/10/11. * 2. Remove padding so people aren't caught out if they zero out fieldsets. */ legend { border: 0; /* 1 */ padding: 0; /* 2 */ } /** * Remove default vertical scrollbar in IE 8/9/10/11. */ textarea { overflow: auto; } /** * Don't inherit the `font-weight` (applied by a rule above). * NOTE: the default cannot safely be changed in Chrome and Safari on OS X. */ optgroup { font-weight: bold; } /* Tables ========================================================================== */ /** * Remove most spacing between table cells. */ table { border-collapse: collapse; border-spacing: 0; } td, th { padding: 0; } ================================================ FILE: tmpl/category-index.tmpl.html ================================================{{.Title}}
{{.Description}}
{{.Body}}
{{if .Meta}}
{{if .Meta.Topics}}
{{range .Meta.Topics}}
{{.}}
{{end}}
{{end}}
{{end}}
{{if .Related}}
{{end}}
← All {{.CategoryTitle}}