Skip to content

Commit bc59555

Browse files
committed
This very large commit switches to using Docsy theme for site,
as well as also reorganizing the site content to fit the structure from the system defined by https://documentation.divio.com/ Signed-off-by: deadprogram <ron@hybridgroup.com>
1 parent 68b5bfc commit bc59555

File tree

210 files changed

+2020
-165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

210 files changed

+2020
-165
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
public
2-
build
2+
build
3+
node_modules
4+
npm-debug.log

.gitmodules

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "themes/learn"]
2-
path = themes/learn
3-
url = https://github.com/matcornic/hugo-theme-learn.git
1+
[submodule "themes/docsy"]
2+
path = themes/docsy
3+
url = https://github.com/google/docsy.git

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@ Built using Hugo:
88

99
http://gohugo.io/
1010

11-
and the Hugo "Learn" theme:
11+
and the Hugo "Docsy" theme:
1212

13-
https://github.com/matcornic/hugo-theme-learn
13+
https://github.com/google/docsy
1414

15-
## Installation
15+
## Prerequisites
16+
17+
Install Hugo command line tool for your operating system with the "extended" option, along with the needed NodeJS modules for processing the site CSS:
1618

17-
Install Hugo command line tool for your operating system.
19+
https://www.docsy.dev/docs/getting-started/#prerequisites-and-installation
20+
21+
## Installation
1822

1923
Clone this repo using:
2024

@@ -24,9 +28,9 @@ Change directories into the tinygo-site directory:
2428

2529
cd tinygo-site
2630

27-
Install the "Learn" theme:
31+
Install the "Docsy" theme:
2832

29-
git submodule update --init
33+
git submodule update --init --recursive
3034

3135
Now you should be able to run the site locally:
3236

@@ -42,7 +46,4 @@ That's it.
4246

4347
## TODO:
4448

45-
- Generate custom godocs for all tinygo build tags, add to "Documentation" section, and point Godocs links there.
46-
- Activate search.
47-
- Custom domain for all packages
4849
- ?

assets/icons/logo.svg

Lines changed: 110 additions & 0 deletions
Loading
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
$gunmetal: #022f40ff;
2+
$pacific-blue: #38aeccff;
3+
$blue-ncs: #0090c1ff;
4+
$gunmetal-2: #183446ff;
5+
$blue-sapphire: #046e8fff;
6+
$alice-blue: #edf9fcff;
7+
8+
$primary: $blue-sapphire;
9+
$primary-light: $blue-ncs;
10+
$secondary: $gunmetal;
11+
$light: $pacific-blue;
12+
$dark: $gunmetal-2;

config.toml

Lines changed: 65 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,72 @@
11
baseURL = "https://tinygo.org/"
2-
title = "TinyGo - Go on Microcontrollers and WASM"
2+
title = "TinyGo"
33
languageCode = "en-us"
4-
theme = "learn"
4+
theme = "docsy"
5+
6+
enableGitInfo = true
7+
8+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
9+
[blackfriday]
10+
plainIDAnchors = true
11+
hrefTargetBlank = true
12+
angledQuotes = false
13+
latexDashes = true
14+
15+
# Image processing configuration.
16+
[imaging]
17+
resampleFilter = "CatmullRom"
18+
quality = 75
19+
anchor = "smart"
520

621
[markup.goldmark.renderer]
722
unsafe = true
823

24+
# Everything below this are Site Params
25+
926
[params]
10-
# Change default color scheme with a variant one. Can be "red", "blue", "green".
11-
themeVariant = "blue"
12-
# Disable search function. It will hide search bar
13-
disableSearch = true
14-
editURL = "https://github.com/tinygo-org/tinygo-site/edit/release/content/"
15-
disableInlineCopyToClipBoard = true
16-
17-
[[menu.shortcuts]]
18-
name = "<i class='fab fa-github'></i> Github repo"
19-
url = "https://github.com/tinygo-org/tinygo"
20-
weight = 10
21-
22-
[[menu.shortcuts]]
23-
name = "<i class='fa fa-book'></i> Godoc"
24-
url = "https://pkg.go.dev/github.com/tinygo-org/tinygo?tab=doc"
25-
weight = 20
26-
27-
[[menu.shortcuts]]
28-
name = "<i class='fab fa-twitter'></i> Twitter"
29-
url = "https://twitter.com/TinyGolang"
30-
weight = 30
31-
32-
[[menu.shortcuts]]
33-
name = "<i class='fab fa-slack'></i> Slack"
34-
url = "https://gophers.slack.com/messages/CDJD3SUP6/"
35-
weight = 40
27+
copyright = "The TinyGo Authors"
28+
29+
30+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
31+
github_repo = "https://github.com/google/tinygo-site"
32+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
33+
github_project_repo = "https://github.com/tinygo-org/tinygo"
34+
github_branch= "release"
35+
36+
37+
# User interface configuration
38+
[params.ui]
39+
# Enable to show the side bar menu in its compact state.
40+
sidebar_menu_compact = true
41+
# Set to true to disable breadcrumb navigation.
42+
breadcrumb_disable = false
43+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
44+
sidebar_search_disable = false
45+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
46+
navbar_logo = true
47+
# Set to true to disable the About link in the site footer
48+
footer_about_disable = false
49+
50+
[params.links]
51+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
52+
[[params.links.user]]
53+
name ="Twitter"
54+
url = "https://twitter.com/TinyGolang"
55+
icon = "fab fa-twitter"
56+
desc = "Follow us on Twitter to get the latest news!"
57+
[[params.links.user]]
58+
name ="Go Pkg Docs"
59+
url = "https://pkg.go.dev/github.com/tinygo-org/tinygo?tab=doc"
60+
icon = "fa fa-book"
61+
desc = "Package Documentation"
62+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
63+
[[params.links.developer]]
64+
name = "GitHub"
65+
url = "https://github.com/tinygo-org/tinygo"
66+
icon = "fab fa-github"
67+
desc = "Development takes place here!"
68+
[[params.links.developer]]
69+
name = "Slack"
70+
url = "https://gophers.slack.com/messages/CDJD3SUP6/"
71+
icon = "fab fa-slack"
72+
desc = "Chat with other project developers"

content/_index.md

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,51 @@
11
---
2-
title: "Home"
2+
title: "TinyGo Home"
33
---
4-
# TinyGo - A Go Compiler For Small Places
54

6-
TinyGo is a project to bring the [Go programming language](https://golang.org) to microcontrollers and modern web browsers by creating a new compiler based on [LLVM](https://llvm.org/).
5+
{{< blocks/cover title="TinyGo - A Go Compiler For Small Places" image_anchor="top" height="full" color="primary" >}}
6+
7+
![TinyGo Logo](images/tinygo-logo.png)
8+
9+
<div class="mx-auto">
10+
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/getting-started" >}}">
11+
Get Started <i class="fas fa-arrow-alt-circle-right ml-2"></i>
12+
</a>
13+
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/tinygo-org/tinygo">
14+
See the code <i class="fab fa-github ml-2 "></i>
15+
</a>
16+
<p class="lead mt-5">Go on embedded systems and WebAssembly</p>
17+
{{< blocks/link-down color="info" >}}
18+
</div>
19+
{{< /blocks/cover >}}
20+
21+
{{% blocks/lead color="secondary" %}}
22+
TinyGo is a project to bring the [Go programming language](https://golang.org) to embedded systems and the modern web by creating a new compiler based on [LLVM](https://llvm.org/).
723

824
You can compile and run TinyGo programs on many different microcontroller boards such as the [BBC micro:bit](https://www.microbit.co.uk/) and the [Arduino Uno](https://store.arduino.cc/usa/arduino-uno-rev3/).
925

1026
TinyGo can also be used to produce [WebAssembly (WASM)](https://webassembly.org/) code which is very compact in size.
27+
{{% /blocks/lead %}}
28+
29+
{{< blocks/section color="primary-light" >}}
30+
{{% blocks/feature icon="fa-lightbulb" title="TinyGo Playground" url="https://play.tinygo.org/" %}}
31+
Try the TinyGo Playground online
32+
{{% /blocks/feature %}}
33+
34+
{{% blocks/feature icon="fab fa-github" title="Show me the code!" url="https://github.com/tinygo-org/tinygo" %}}
35+
Just want to see the code?
36+
{{% /blocks/feature %}}
1137

12-
Just want to see the code? Go to the Github repository at [https://github.com/tinygo-org/tinygo](https://github.com/tinygo-org/tinygo).
1338

39+
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/tinygolang" %}}
40+
For all the latest and greatest
41+
{{% /blocks/feature %}}
42+
43+
{{< /blocks/section >}}
44+
45+
46+
{{< blocks/section color="secondary">}}
1447
TinyGo also has support for several different devices such as accelerometers and magnetometers. Check out the Github repository at [https://github.com/tinygo-org/drivers](https://github.com/tinygo-org/drivers) for more information.
1548

1649
Ready to get started? [Click here](getting-started).
50+
51+
{{< /blocks/section >}}

content/arduino-background.jpg

275 KB
Loading

content/compiler-internals/_index.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

content/docs/_index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: "Documentation"
3+
linkTitle: "Documentation"
4+
weight: 20
5+
menu:
6+
main:
7+
weight: 20
8+
---
9+
10+
The TinyGo documentation is organized into specific sections to help you locate the information that you need.

0 commit comments

Comments
 (0)