forked from google/docsy
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Hugo documentation theme and example site
- Loading branch information
0 parents
commit 91dcacf
Showing
269 changed files
with
34,330 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
|
||
public/ | ||
resources/ | ||
node_modules/ | ||
tech-doc-hugo | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
[submodule "themes/tech-doc-hugo-theme/assets/vendor/bootstrap"] | ||
path = themes/tech-doc-hugo-theme/assets/vendor/bootstrap | ||
url = https://github.com/twbs/bootstrap.git | ||
[submodule "themes/tech-doc-hugo-theme/assets/vendor/Font-Awesome"] | ||
path = themes/tech-doc-hugo-theme/assets/vendor/Font-Awesome | ||
url = https://github.com/FortAwesome/Font-Awesome.git |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
routes: | ||
- route: "^.+\\.(js|css|svg|ttf)$" | ||
# cache static assets for 20 years | ||
headers: | ||
Cache-Control: "max-age=630720000, no-transform, public" | ||
gzip: true | ||
- route: "^.+\\.(png|jpg)$" | ||
headers: | ||
Cache-Control: "max-age=630720000, no-transform, public" | ||
gzip: true | ||
- route: "^.+\\.(html|xml|json)$" | ||
gzip: true | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Tech Doc Hugo | ||
|
||
Hugo theme and skeleton project. | ||
|
||
## Installation | ||
|
||
You need a recent version of Hugo to run this project (preferably 0.45+). If you install from the [release page](https://github.com/gohugoio/hugo/releases), make sure to get the `extended` Hugo version. Alternatively, on macOS you can install via Brew. | ||
|
||
If you want to do stylesheet changes, you will also need `PostCSS` to create the final assets. You can also install it locally with: | ||
|
||
``` | ||
npm install | ||
```` | ||
Clone the repo using: | ||
``` | ||
git clone --recurse-submodules --depth 1 https://github.com/bep/tech-doc-hugo.git | ||
``` | ||
## Running the website locally | ||
From the repo root folder, run: | ||
``` | ||
hugo server | ||
``` | ||
Navigate to http://localhost:1313/td/docs/theme-documentation/ to read the theme documentaton. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: "{{ replace .Name "-" " " | title }}" | ||
date: {{ .Date }} | ||
draft: true | ||
--- | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/* | ||
Add styles or override variables from the theme here. | ||
*/ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,118 @@ | ||
baseURL = "https://temp.bep.is/td/" | ||
title = "Tech OS" | ||
|
||
enableRobotsTXT = true | ||
|
||
# Hugo allows theme composition (and inheritance). The precedence is from left to right. | ||
theme = ["tech-doc-hugo-theme"] | ||
|
||
# Will give values to .Lastmod etc. | ||
enableGitInfo = true | ||
|
||
# Language settings | ||
contentDir = "content/en" | ||
defaultContentLanguage = "en" | ||
defaultContentLanguageInSubdir = false | ||
# Useful when translating. | ||
enableMissingTranslationPlaceholders = true | ||
|
||
disableKinds = ["taxonomy", "taxonomyTerm"] | ||
|
||
# Highlighting config | ||
pygmentsCodeFences = true | ||
pygmentsUseClasses = false | ||
# Use the new Chroma Go highlighter in Hugo. | ||
pygmentsUseClassic = false | ||
#pygmentsOptions = "linenos=table" | ||
# See https://help.farbox.com/pygments.html | ||
pygmentsStyle = "tango" | ||
|
||
# First one is picked as the Twitter card image if not set on page. | ||
#images = ["images/project-illustration.png"] | ||
|
||
# Configure how URLs look like per section. | ||
[permalinks] | ||
blog = "/:section/:year/:month/:day/:slug/" | ||
|
||
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday | ||
[blackfriday] | ||
plainIDAnchors = true | ||
hrefTargetBlank = true | ||
angledQuotes = false | ||
latexDashes = true | ||
|
||
# Image processing configuration. | ||
[imaging] | ||
resampleFilter = "CatmullRom" | ||
quality = 75 | ||
anchor = "smart" | ||
|
||
[services] | ||
[services.googleAnalytics] | ||
# Uncomment and insert your GA tracking ID to enable. | ||
# id = "INSERT ID" | ||
|
||
# Language configuration | ||
|
||
[languages] | ||
[languages.en] | ||
title = "TechOS" | ||
description = "TechOS is containers revisited" | ||
languageName ="English" | ||
# Weight used for sorting. | ||
weight = 1 | ||
[languages.no] | ||
title = "TechOS" | ||
description = "TecOS er operativsystem for skyen" | ||
languageName ="Norsk" | ||
contentDir = "content/no" | ||
time_format_default = "02.01.2006" | ||
time_format_blog = "02.01.2006" | ||
|
||
|
||
# Everything below this are Site Params | ||
|
||
[params] | ||
copyright = "Global Inc" | ||
privacy_policy = "https://policies.google.com/privacy" | ||
github_repo = "https://github.com/bep/tech-doc-hugo" | ||
|
||
# Google Custom Search Engine ID. Remove or comment out to disable search. | ||
gcs_engine_id = "011737558837375720776:fsdu1nryfng" | ||
|
||
# User interface configuration | ||
[params.ui] | ||
# Enable to show the side bar menu in its compact state. | ||
sidebar_menu_compact = false | ||
# Set to true to disable breadcrumb navigation. | ||
breadcrumb_disable = false | ||
|
||
[params.links] | ||
# End user relevant links. These will show up on left side of footer. | ||
[[params.links.user]] | ||
name = "Mailing List" | ||
url = "https://example.org/mail" | ||
icon = "fa fa-envelope" | ||
[[params.links.user]] | ||
name ="Twitter" | ||
url = "https://example.org/twitter" | ||
icon = "fab fa-twitter" | ||
[[params.links.user]] | ||
name = "Stack Overflow" | ||
url = "https://example.org/stack" | ||
icon = "fab fa-stack-overflow" | ||
# Developer relevant links. These will show up on right side of footer. | ||
[[params.links.developer]] | ||
name = "GitHub" | ||
url = "https://example.org/github" | ||
icon = "fab fa-github" | ||
[[params.links.developer]] | ||
name = "Slack" | ||
url = "https://example.org/slack" | ||
icon = "fab fa-slack" | ||
[[params.links.developer]] | ||
name = "Mailing List" | ||
url = "https://example.org/mail" | ||
icon = "fa fa-envelope" | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
+++ | ||
title = "TechOS" | ||
linkTitle = "TechOS" | ||
|
||
+++ | ||
|
||
{{< blocks/cover title="Welcome to the cool TechOS!" image_anchor="top" height="full" color="orange" >}} | ||
<div class="mx-auto"> | ||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}"> | ||
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i> | ||
</a> | ||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/bep"> | ||
Download <i class="fab fa-github ml-2 "></i> | ||
</a> | ||
<p class="lead mt-5">TechOS is now available in <a href="#">AppStore!</a></p> | ||
<div class="mx-auto mt-5"> | ||
{{< blocks/link-down color="info" >}} | ||
</div> | ||
</div> | ||
{{< /blocks/cover >}} | ||
|
||
|
||
{{% blocks/lead color="primary" %}} | ||
TechOS is the OS of the future. | ||
|
||
Runs on **bare metal** in the **cloud**! | ||
{{% /blocks/lead %}} | ||
|
||
{{< blocks/section color="dark" >}} | ||
{{% blocks/feature icon="fa-lightbulb" title="Fastest OS **on the planet**!" %}} | ||
The new **TechOS** operating system is an open source project. It is a new project, but with grand ambitions. | ||
|
||
Please follow this space for updates! | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}} | ||
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome! | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}} | ||
For announcement of latest features etc. | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{< /blocks/section >}} | ||
|
||
|
||
{{< blocks/section >}} | ||
<div class="col"> | ||
<h1 class="text-center">This is the second Section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} | ||
|
||
|
||
|
||
{{< blocks/section >}} | ||
{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}} | ||
The new **TechOS** operating system is an open source project. It is a new project, but with grand ambitions. | ||
|
||
Please follow this space for updates! | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}} | ||
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New users are always welcome! | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}} | ||
For announcement of latest features etc. | ||
{{% /blocks/feature %}} | ||
|
||
|
||
{{< /blocks/section >}} | ||
|
||
{{< blocks/section >}} | ||
|
||
<div class="col-12"> | ||
<h1 class="text-center">This is another Section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: About TechOS | ||
linkTitle: About | ||
menu: | ||
main: | ||
weight: 10 | ||
|
||
--- | ||
|
||
|
||
{{< blocks/cover title="About TechOS" image_anchor="bottom" height="min" >}} | ||
|
||
<p class="lead mt-5">This page is about the project.</p> | ||
|
||
{{< /blocks/cover >}} | ||
|
||
{{% blocks/lead %}} | ||
A lead section in About. | ||
|
||
Runs on **bare metal** in the **cloud**! | ||
{{% /blocks/lead %}} | ||
|
||
|
||
{{< blocks/section >}} | ||
<div class="col-12"> | ||
<h1 class="text-center">This is the second Section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} | ||
|
||
|
||
|
||
{{< blocks/section >}} | ||
|
||
<div class="col-12"> | ||
<h1 class="text-center">This is the third Section</h1> | ||
</div> | ||
|
||
{{< /blocks/section >}} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
title: "Tech OS Blog" | ||
linkTitle: "Blog" | ||
menu: | ||
main: | ||
weight: 30 | ||
--- | ||
|
||
|
||
This is the **blog** section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
|
||
--- | ||
title: "News About The Project" | ||
linkTitle: "News" | ||
weight: 20 | ||
--- | ||
|
||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.