From 04edaefad7ed4f9dce9281a25480c1c6eb9e303d Mon Sep 17 00:00:00 2001 From: Patrick Georgi Date: Wed, 24 May 2017 22:58:01 +0200 Subject: util/hugo: Add framework to build www.coreboot.org/Documentation www.coreboot.org/Documentation is now built with hugo (www.gohugo.io) based on files in this repo's /Documentation directory. Also clarify that new additions to Documentation are under CC-BY 4.0 terms. Change-Id: I000e15b29a182bb88b40de3d0178bf8cc54ba8af Signed-off-by: Patrick Georgi Reviewed-on: https://review.coreboot.org/19881 Tested-by: build bot (Jenkins) Reviewed-by: Philipp Deppenwiese --- util/hugo/Makefile | 13 + util/hugo/config.toml | 48 ++ util/hugo/static/css/coreboot.css | 104 ++++ util/hugo/static/fonts/icon.eot | Bin 0 -> 2224 bytes util/hugo/static/fonts/icon.svg | 22 + util/hugo/static/fonts/icon.ttf | Bin 0 -> 2072 bytes util/hugo/static/fonts/icon.woff | Bin 0 -> 2148 bytes util/hugo/static/images/coreboot.svg | 963 +++++++++++++++++++++++++++++++++++ util/hugo/static/images/favicon.png | Bin 0 -> 15086 bytes 9 files changed, 1150 insertions(+) create mode 100644 util/hugo/Makefile create mode 100644 util/hugo/config.toml create mode 100644 util/hugo/static/css/coreboot.css create mode 100755 util/hugo/static/fonts/icon.eot create mode 100755 util/hugo/static/fonts/icon.svg create mode 100755 util/hugo/static/fonts/icon.ttf create mode 100755 util/hugo/static/fonts/icon.woff create mode 100644 util/hugo/static/images/coreboot.svg create mode 100644 util/hugo/static/images/favicon.png (limited to 'util') diff --git a/util/hugo/Makefile b/util/hugo/Makefile new file mode 100644 index 0000000000..d49c57d7e9 --- /dev/null +++ b/util/hugo/Makefile @@ -0,0 +1,13 @@ +.SILENT: +.PHONY: error public + +error: + echo please state a valid target + exit 1 + +themes/hugo-material-docs: + mkdir -p themes + git clone https://github.com/digitalcraftsman/hugo-material-docs.git themes/hugo-material-docs + +public: themes/hugo-material-docs + docker run --rm -it -v $$PWD:/src -v $$PWD/../../Documentation:/src/content -v /srv/www/vhosts/www.coreboot.org/Documentation:/src/public jguyomard/hugo-builder hugo --forceSyncStatic --cleanDestinationDir diff --git a/util/hugo/config.toml b/util/hugo/config.toml new file mode 100644 index 0000000000..d29a20dbd3 --- /dev/null +++ b/util/hugo/config.toml @@ -0,0 +1,48 @@ +baseurl = "https://www.coreboot.org/Documentation/" +languageCode = "en-us" +title = "coreboot documentation" +theme = "hugo-material-docs" +metadataformat = "yaml" +canonifyurls = true + +[params] + provider = "Coreboot" + repo_url = "https://review.coreboot.org/cgit/coreboot.git" + logo = "images/coreboot.svg" + favicon = "images/favicon.png" + copyright = "coreboot™ contributors, licensed under the terms described in https://creativecommons.org/licenses/by/4.0/" + custom_css = [ + "css/coreboot.css" + ] + +[social] + twitter= "coreboot_org" + github = "coreboot/coreboot" + +[params.palette] + primary = "blue" + accent = "blue-grey" + +[params.font] + text = "Open Sans" + code = "Inconsolata" + +[[menu.main]] + name = "Gerrit guidelines" + url = "gerrit_guidelines/" + weight = 10 + +[[menu.main]] + name = "On timestamps" + url = "timestamp/" + weight = 20 + +[[menu.main]] + name = "Intel documentation" + url = "intel/index.html" + weight = 30 + +[[menu.main]] + name = "AMD S3" + url = "AMD-S3.txt" + weight = 40 diff --git a/util/hugo/static/css/coreboot.css b/util/hugo/static/css/coreboot.css new file mode 100644 index 0000000000..5d6c6839fa --- /dev/null +++ b/util/hugo/static/css/coreboot.css @@ -0,0 +1,104 @@ +aside.copyright { + padding-top: 30px; + color: rgba(0,0,0,0.3); +} + +.article h3, .article h4 { color:#3f51b5; } +.article h4 { font-style: normal; } + + +.article dl { +} + +.article dl > dt { + margin-top: 1.5em; + display: block; + + font-style: italic; +} + +.article dl > dd { + margin-left: 1.5em; + margin-bottom: 10px; +} + +.article dl > dd > p { + margin-top: 1em; +} + +.article dl > dd > p:first-child { + margin-top: 0px; +} + +.article code { + background: rgba(0,0,0,.05); + border: 1px solid rgba(0,0,0,.05); + padding: 0px 4px; + margin: 1px; + color: inherit !important; + + border-radius: 2px; + -moz-border-radius: 2px; + -webkit-border-radius: 2px; +} + +.article .admonition code { + background: hsla(0,0%,100%,.3); +} + +.article pre > code { + background: none; + margin: 0px; + padding: 0px; + border: none; +} + +.article .admonition pre > code { + background: none; +} + +.article li p { + display: block; + margin-top: 0.5em; +} + +.article ul>li ul>li:before { + content: "∙"; +} + +@font-face { + font-family: 'Open Sans'; + font-style: normal; + font-weight: 600; + src: local('Open Sans Semibold'), local('OpenSans-Semibold'), url(https://fonts.gstatic.com/s/opensans/v13/MTP_ySUJH_bn48VBG8sNSonF5uFdDttMLvmWuJdhhgs.ttf) format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: italic; + font-weight: 600; + src: local('Open Sans Semibold Italic'), local('OpenSans-SemiboldItalic'), url(https://fonts.gstatic.com/s/opensans/v13/PRmiXeptR36kaC0GEAetxi8cqLH4MEiSE0ROcU-qHOA.ttf) format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: italic; + font-weight: 400; + src: local('Open Sans Italic'), local('OpenSans-Italic'), url(https://fonts.gstatic.com/s/opensans/v13/xjAJXh38I15wypJXxuGMBp0EAVxt0G0biEntp43Qt6E.ttf) format('truetype'); +} +@font-face { + font-family: 'Open Sans'; + font-style: normal; + font-weight: 700; + src: local('Open Sans Bold'), local('OpenSans-Bold'), url(https://fonts.gstatic.com/s/opensans/v13/k3k702ZOKiLJc3WVjuplzInF5uFdDttMLvmWuJdhhgs.ttf) format('truetype'); +} + +.article .admonition { + font-weight: 600; +} + +.article .admonition-title { + font-weight: 400; +} + +.coreboot-download { + width: 50%; +} diff --git a/util/hugo/static/fonts/icon.eot b/util/hugo/static/fonts/icon.eot new file mode 100755 index 0000000000..8f81638c2d Binary files /dev/null and b/util/hugo/static/fonts/icon.eot differ diff --git a/util/hugo/static/fonts/icon.svg b/util/hugo/static/fonts/icon.svg new file mode 100755 index 0000000000..86250e7b40 --- /dev/null +++ b/util/hugo/static/fonts/icon.svg @@ -0,0 +1,22 @@ + + + +Generated by IcoMoon + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/util/hugo/static/fonts/icon.ttf b/util/hugo/static/fonts/icon.ttf new file mode 100755 index 0000000000..b5ab5601be Binary files /dev/null and b/util/hugo/static/fonts/icon.ttf differ diff --git a/util/hugo/static/fonts/icon.woff b/util/hugo/static/fonts/icon.woff new file mode 100755 index 0000000000..ed0f20d5b8 Binary files /dev/null and b/util/hugo/static/fonts/icon.woff differ diff --git a/util/hugo/static/images/coreboot.svg b/util/hugo/static/images/coreboot.svg new file mode 100644 index 0000000000..d4284ed2f0 --- /dev/null +++ b/util/hugo/static/images/coreboot.svg @@ -0,0 +1,963 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/util/hugo/static/images/favicon.png b/util/hugo/static/images/favicon.png new file mode 100644 index 0000000000..ca4d789f35 Binary files /dev/null and b/util/hugo/static/images/favicon.png differ -- cgit v1.2.3