From 6eec52857afaabbf756099a968e665ea07536bca Mon Sep 17 00:00:00 2001 From: cdeck3r Date: Tue, 6 Aug 2019 13:57:29 +0200 Subject: Initial version of OneDly hugo theme for project documentation. --- LICENSE.md | 2 +- README.md | 51 +++++---- exampleSite/config.toml | 80 ++++++++++++-- layouts/_default/list.html | 2 +- layouts/index.html | 2 +- layouts/partials/footer.html | 13 ++- layouts/partials/head.html | 19 +++- layouts/partials/header.html | 27 ++--- layouts/partials/js.html | 9 +- layouts/partials/main.html | 28 +++++ layouts/partials/nav.html | 17 +-- layouts/partials/services.html | 28 ----- layouts/partials/social.html | 232 +++++++++++++++++++++++++++++++++++++++++ static/css/landing-page.css | 5 +- theme.toml | 12 +-- 15 files changed, 427 insertions(+), 100 deletions(-) create mode 100644 layouts/partials/main.html delete mode 100644 layouts/partials/services.html create mode 100644 layouts/partials/social.html diff --git a/LICENSE.md b/LICENSE.md index 32fea66..65c69a5 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2014 YOUR_NAME_HERE +Copyright (c) 2019 Christian Decker Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index 8f37043..7c08ce3 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,49 @@ # One-Day-Only (OneDly) Project Theme -This [Hugo](http://gohugo.io) theme is for documenting One-Day-Only (OneDly) projects. The theme is based on [Github project Page](https://themes.gohugo.io/github-project-landing-page/). - - -... +This [Hugo](http://gohugo.io) theme is for documenting One-Day-Only (OneDly) projects. The theme renders a single page and is based on [Github project Page](https://themes.gohugo.io/github-project-landing-page/). # Demo -A demo can be find here [Swiftline](http://swiftline.github.io) +A demo can be find here [...](https://github.com/cdeck3r/OneDly-Theme) # Screenshot -![screenshot](https://raw.githubusercontent.com/nsomar/github-project-landing-page/master/images/screenshot.png) +![screenshot](...) + +# Notable Differences + +* Social media links as buttons at the top of the page +* Social media sharing links as buttons at the end of the page +* All posts on a single page as separated sections +* Post ordering by sec parameter, instead of date + +# Customization + +Check [config.toml](https://github.com/cdeck3r/OneDly-Theme/blob/master/exampleSite/config.toml) for available configuration. -# Costumization -Check [config.toml](https://github.com/nsomar/github-project-landing-page/blob/master/exampleSite/config.toml) for available configuration. Below is a description for each of them. -Project description appears after project name +The project name is specified as the title of the site. ``` +title = "OneDly Project" +``` + +The project description follows in the `params` section. +``` +[params] description = "Amazing project." ``` -`author_url` a link of the project author. -`project_url` link to project url -`project_documentation` link to project documentation +Other variables are +`author_name` the project author's name. +`author_url` link to the personal website of the project author. +`project_url` link to project url, e.g. the project's github repo -``` - author_url = "http://nsomar.com" - project_url = "http://github.com/swiftline/swiftline" - project_documentation = "http://swiftline.github.io/docs" +**Note:** `description` and `author_name` are put into the site's meta data for author and the site description. ``` - -`github_user_name` github author account name -`github_project_name` github project name -``` - github_project_name = "swiftline" - github_user_name = "swiftline" + author_name = "cdeck3r" + author_url = "//cdeck3r.com" + project_url = "//github.com/cdeck3r/OneDly-Theme" ``` Theme colors diff --git a/exampleSite/config.toml b/exampleSite/config.toml index e042ed5..ea5f683 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -1,14 +1,28 @@ -baseurl = "http://swiftline.github.io" +baseurl = "" languageCode = "en-us" -title = "Swiftline" +title = "OneDly Project" +theme = "onedly" [params] - description = "Amazing project." - author_url = "http://nsomar.com" - project_url = "http://github.com/swiftline/swiftline" - project_documentation = "http://swiftline.github.io/docs" - github_project_name = "swiftline" - github_user_name = "swiftline" + description = "One-Day-Only (OneDly) project documentation." + author_url = "http://cdeck3r.com" + author_name = "cdeck3r" + project_url = "https://github.com/cdeck3r/OneDly-Theme" + github_project_name = "OneDly" + github_user_name = "cdeck3r" + + # Sets Social Share links to appear on posts + socialShare = true + # Sets specific share to appear on posts (default behavior is to appear) + socialShareTwitter = true + socialShareGoogleplus = true + socialShareFacebook = true + socialShareReddit = true + socialShareLinkedin = true + socialShareStumbleupon = true + socialSharePinterest = true + socialShareEmail = true + first_color="#f8f8f8" first_border_color="#e7e7e7" @@ -22,3 +36,53 @@ title = "Swiftline" header_link_color="#777" header_link_hover_color="rgb(51, 51, 51)" + +# Sets Social Media icons to appear and link to your account. Value should be your +# username unless otherwise noted. These are the icons affected by socialAppearAtTop +# and socialAppearAtBottom. +[social] + # Coding Communities + github = "cdeck3r/OneDly-Theme" + gitlab = "" + stackoverflow = "" # User Number + bitbucket = "" + jsfiddle = "" + codepen = "" + # Visual Art Communities + deviantart = "" + flickr = "" + behance = "" + dribbble = "" + # Publishing Communities + wordpress = "" + medium = "" + # Professional/Business Oriented Communities + linkedin = "" + linkedin_company = "" + foursquare = "" + xing = "" + slideshare = "" + # Social Networks + facebook = "" + googleplus = "" + reddit = "" + quora = "" + youtube = "channel/UCZ5wNVV_E6AA3L3C-mvqwSA" + vimeo = "" + whatsapp = "" # WhatsApp Number + # WeChat and QQ need testing. + wechat = "" + qq = "" # User ID Number + instagram = "" + tumblr = "" + twitter = "cdeck3r" + skype = "" + snapchat = "" + pinterest = "" + telegram = "" + vine = "" + googlescholar = "" + orcid = "" + researchgate = "" + # Email + email = "info@cdeck3r.com" diff --git a/layouts/_default/list.html b/layouts/_default/list.html index 6f3da26..a9e08f8 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -1,4 +1,4 @@ {{ partial "head.html" . }} {{ partial "header.html" . }} -{{ partial "services.html" . }} +{{ partial "main.html" . }} {{ partial "footer.html" . }} diff --git a/layouts/index.html b/layouts/index.html index 0a0af79..c1ccacd 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,5 +1,5 @@ {{ partial "head.html" . }} {{ partial "nav.html" . }} {{ partial "header.html" . }} -{{ partial "services.html" . }} +{{ partial "main.html" . }} {{ partial "footer.html" . }} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index d4f524b..b0abc6d 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -3,12 +3,17 @@
-

Copyright © {{ .Title }} All Rights Reserved

+
    +
  • + Up +
    • +
+

Copyright © {{ .Title }} All Rights Reserved

- Built with Hugo and the - Github project Page - theme. + Built with Hugo and the + OneDly project + theme.
diff --git a/layouts/partials/head.html b/layouts/partials/head.html index 08d96d5..8331f01 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -5,8 +5,15 @@ - - + + + {{ .Title }} @@ -18,6 +25,14 @@ + + + + +