danog/gojekyll
1
0
Fork 0
mirror of https://github.com/danog/gojekyll.git synced 2025-01-23 02:01:12 +01:00
Code Issues Projects Releases Wiki Activity

implement (much of) jekyll-github-metadata

Browse Source
This commit is contained in:
Oliver Steele 2017-07-24 13:27:05 -04:00
parent 7c21bdbe13
commit 20a6e9c906
5 changed files with 77 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/Gemfile
View File

@ -1,3 +1,3 @@
gem "minima"
gem "jekyll-theme-minimal"
gem "jekyll-optional-front-matter"
gem 'jekyll-theme-minimal'
gem 'jekyll-github-metadata'
gem 'jekyll-optional-front-matter'

3
docs/_config.yml
View File

@ -1,6 +1,5 @@
theme: jekyll-theme-minimal
title: Gojekyll
description: A Go clone of the Jekyll static site generator.
gems:
- jekyll-github-metadata
- jekyll-optional-front-matter

2
docs/plugins.md
View File

@ -11,7 +11,7 @@ The functionality of some plugins is built into the core program:
| jekyll-default-layout | GitHub Pages | ✓ | |
| jekyll-feed | GitHub Pages | ✓ | |
| jekyll-gist | core³ | ✓ | `noscript` |
| jekyll-github-metadata | GitHub Pages | | |
| jekyll-github-metadata | GitHub Pages | some | |
| jekyll-live-reload | core | ✓ (always enabled) | |
| jekyll-mentions | GitHub Pages | ✓ | |
| jekyll-optional-front-matter | GitHub Pages | | |

71
plugins/plugins.go
View File

@ -6,9 +6,13 @@
package plugins
import (
"context"
"fmt"
"os/exec"
"regexp"
"strings"
"github.com/google/go-github/github"
"github.com/kyokomi/emoji"
"github.com/osteele/gojekyll/config"
"github.com/osteele/gojekyll/pages"
@ -26,18 +30,20 @@ type Site interface {
// Plugin describes the hooks that a plugin can override.
type Plugin interface {
ConfigureTemplateEngine(*liquid.Engine) error
PostRender([]byte) []byte
Initialize(Site) error
PostRead(site Site) error
ConfigureTemplateEngine(*liquid.Engine) error
ModifySiteDrop(Site, map[string]interface{}) error
PostRead(Site) error
PostRender([]byte) []byte
}
type plugin struct{}
func (p plugin) Initialize(Site) error { return nil }
func (p plugin) ConfigureTemplateEngine(*liquid.Engine) error { return nil }
func (p plugin) PostRead(Site) error { return nil }
func (p plugin) PostRender(b []byte) []byte { return b }
func (p plugin) Initialize(Site) error { return nil }
func (p plugin) ConfigureTemplateEngine(*liquid.Engine) error { return nil }
func (p plugin) ModifySiteDrop(Site, map[string]interface{}) error { return nil }
func (p plugin) PostRead(Site) error { return nil }
func (p plugin) PostRender(b []byte) []byte { return b }
// Lookup returns a plugin if it has been registered.
func Lookup(name string) (Plugin, bool) {
@ -67,7 +73,8 @@ func register(name string, p Plugin) {
}
func init() {
register("jemoji", jekyllJemojiPlugin{})
register("jemoji", jemojiPlugin{})
register("jekyll-github-metadata", jekyllGithubMetadataPlugin{})
register("jekyll-mentions", jekyllMentionsPlugin{})
register("jekyll-optional-front-matter", jekyllOptionalFrontMatterPlugin{})
@ -81,15 +88,59 @@ func init() {
// jekyll-jemoji
type jekyllJemojiPlugin struct{ plugin }
type jemojiPlugin struct{ plugin }
func (p jekyllJemojiPlugin) PostRender(b []byte) []byte {
func (p jemojiPlugin) PostRender(b []byte) []byte {
return utils.ApplyToHTMLText(b, func(s string) string {
s = emoji.Sprint(s)
return s
})
}
// jekyll-github-metadata
type jekyllGithubMetadataPlugin struct{ plugin }
func (p jekyllGithubMetadataPlugin) ModifySiteDrop(s Site, d map[string]interface{}) error {
cmd := exec.Command("git", "remote", "-v") // nolint: gas
cmd.Dir = s.Config().SourceDir()
out, err := cmd.Output()
if err != nil {
return err
}
m := regexp.MustCompile(`origin\s+https://github.com/(.+?)/(.+)\.git\b`).FindStringSubmatch(string(out))
owner, name := m[1], m[2]
nwo := fmt.Sprintf("%s/%s", owner, name)
client := github.NewClient(nil)
var ctx = context.Background()
repo, _, err := client.Repositories.Get(ctx, owner, name)
userPage := *repo.Name == fmt.Sprintf("%s.github.com", strings.ToLower(*repo.Owner.Login))
gh := map[string]interface{}{
"clone_url": repo.CloneURL,
"language": repo.Language,
"owner_gravatar_url": repo.Owner.GravatarID,
"owner_name": repo.Owner.Login,
"owner_url": repo.Owner.URL,
"project_tagline": repo.Description,
"project_title": repo.Name, // TODO is this right?
"repository_name": repo.Name,
"repository_nwo": nwo,
"repository_url": repo.URL,
"releases_url": repo.ReleasesURL,
"latest_release_url": repo.URL,
"issues_url": repo.IssuesURL,
"show_downloads?": repo.HasDownloads,
"repo_clone_url": repo.GitURL,
"is_project_page": !userPage,
"is_user_page": userPage,
// TODO
// contributors environment public_repositories releases releases_url
// show_downloads tar_url zip_url url versions wiki_url
}
d["github"] = gh
return err
}
// jekyll-mentions
type jekyllMentionsPlugin struct{ plugin }

15
site/drop.go
View File

@ -4,6 +4,7 @@ import (
"time"
"github.com/osteele/gojekyll/pages"
"github.com/osteele/gojekyll/plugins"
"github.com/osteele/gojekyll/templates"
"github.com/osteele/liquid/evaluator"
)
@ -28,7 +29,7 @@ func (s *Site) MarshalYAML() (interface{}, error) {
}
func (s *Site) initializeDrop() {
vars := templates.MergeVariableMaps(s.config.Variables, map[string]interface{}{
drop := templates.MergeVariableMaps(s.config.Variables, map[string]interface{}{
"data": s.data,
"documents": s.docs,
"html_files": s.htmlFiles(),
@ -40,13 +41,19 @@ func (s *Site) initializeDrop() {
})
collections := []interface{}{}
for _, c := range s.Collections {
vars[c.Name] = c.Pages()
drop[c.Name] = c.Pages()
collections = append(collections, c.ToLiquid())
}
evaluator.SortByProperty(collections, "label", true)
vars["collections"] = collections
s.drop = vars
drop["collections"] = collections
s.drop = drop
s.setPostVariables()
err := s.runHooks(func(h plugins.Plugin) error {
return h.ModifySiteDrop(s, drop)
})
if err != nil {
panic(err)
}
}
func (s *Site) setPageContent() error {