A Github project landing page theme for Hugo.
HTML CSS JavaScript
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 9 commits ahead, 1 commit behind nsomar:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
archetypes
exampleSite
images
layouts
static
.gitignore
LICENSE.md
README.md
VERSION
theme.toml

README.md

Github project landing page

MIT License

Github landing page is a theme for Hugo to create landing pages for github projects. This theme is originally made by Omar Abdelhafith, and licensed under the MIT license. See LICENSE for more information.

Screenshot

screenshot

Costumization

Check config.toml for available configuration. Below is a description for each of them.

Project sub title appears after project name

[params]
  SubTitle = "Amazing project."
  • AuthorURL a link of the project author.
  • GithubURL link to project url
[params]
  AuthorURL = "https://www.jkawamoto.info/"
  GithubURL = "https://github.com/jkawamoto/gii"
  • GithubRepo github author account name
  • GithubRepo github project name
[params]
  GithubRepo = "github-project-landing-page"
  GithubOrg = "jkawamoto"

Syntax highlighting is supported by highlight.js,

  • HighlightStyle URL of a CSS file
  • HighlightLanguages list of languages to be loaded
[params]
  HighlightStyle = "//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/agate.min.css"
  HighlightLanguages = ["yaml"]

Several sizes of favicon are supported

[params]
  Favicon = "img/favicon.ico"
  Icon16 = "img/icon_16.png"
  Icon32 = "img/icon_32.png"
  Icon96 = "img/icon_96.png"

Theme colors

[params]
  first_color="#f8f8f8"
  first_border_color="#e7e7e7"
  first_text_color="#333"

  second_color="white"
  second_text_color="#333"

  header_color="#f8f8f8"
  header_text_color="rgb(51, 51, 51)"

  header_link_color="#777"
  header_link_hover_color="rgb(51, 51, 51)"

License

This software is released under the MIT License, see LICENSE.