Skip to content
This repository was archived by the owner on Apr 28, 2020. It is now read-only.

Commit 9044b44

Browse files
ammarionhooyr
authored andcommitted
Doc scaffolding
1 parent afb1eb4 commit 9044b44

File tree

8 files changed

+46
-21
lines changed

8 files changed

+46
-21
lines changed

.sail/Dockerfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
FROM codercom/ubuntu-dev-go
22
RUN sudo apt-get install -y htop hugo
33
LABEL project_root "~/go/src/go.coder.com"
4+
5+
# Modules break much of Go's tooling.
6+
ENV GO111MODULE=off

config_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,10 @@ func Test_resolvePath(t *testing.T) {
2323
{"Abs", args{"/home/ammar", "/home/ammar/test"}, "/home/ammar/test"},
2424
{"NoRel", args{"/home/ammar", wd}, wd},
2525
}
26+
2627
for _, tt := range tests {
2728
t.Run(tt.name, func(t *testing.T) {
29+
2830
if got := resolvePath(tt.args.homedir, tt.args.path); got != tt.want {
2931
t.Errorf("resolvePath() = %v, want %v", got, tt.want)
3032
}

globalflags.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ func (gf *globalFlags) debug(msg string, args ...interface{}) {
1717
if !gf.verbose {
1818
return
1919
}
20+
2021
flog.Log(
2122
flog.Level(color.New(color.FgHiMagenta).Sprint("DEBUG")),
2223
msg, args...,

runcmd.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ func (c *runcmd) spec() commandSpec {
3737

3838
func (c *runcmd) initFlags(fl *flag.FlagSet) {
3939
c.repoArg = fl.Arg(0)
40+
4041
fl.StringVar(&c.image, "image", "", "Custom docker image to use.")
4142
fl.StringVar(&c.hat, "hat", "", "Custom hat to use.")
4243
fl.BoolVar(&c.keep, "keep", false, "Keep container when it fails to build.")

site/content/docs/index.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,33 @@ browser_title="Sail - Docs - Getting Started"
55
+++
66
Welcome to the the Sail docs.
77

8-
## Install Release
8+
## Install Stable Release
99

10+
### Linux
11+
Binary release
1012

13+
dpkg
14+
15+
### MacOS
16+
17+
### Windows
18+
19+
- Linux
20+
- amd64
21+
- x86
22+
- MacOS/Darwin
1123

1224
## Install From Source
1325

14-
To install `sail` for the first time, run:
26+
To install `sail` the latest version of sail, run:
1527

1628
```bash
1729
go install sail.dev
1830
```
1931

20-
If you don't have Go installed, you can grab it from here.
32+
If you don't have Go installed, you can grab it [here](https://golang.org/dl/).
33+
34+
`go install` will install sail to `~/go/bin/sail`.
35+
2136

2237
### Sub

site/themes/sail/assets/doc.scss

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,21 @@ body {
1212
width: 75%;
1313
}
1414

15-
ul {
16-
padding-inline-start: 25px;
15+
.content-box {
16+
padding-inline-start: 3em;
17+
}
18+
19+
// Hugo Table of Contents
20+
// ul {
21+
// list-style-type: none;
22+
// padding-inline-start: 0;
23+
// }
24+
25+
nav > ul, nav > ul > li > ul {
1726
list-style-type: none;
18-
color: grey;
27+
padding-inline-start: 0;
1928
}
2029

21-
#TableOfContents > ul {
22-
list-style: none;
23-
margin: 0;
24-
padding: 0;
25-
}
30+
#TableOfContents > li {
31+
padding-inline-start: 25px;
32+
}

site/themes/sail/assets/main.scss

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,13 @@ $primary-color: #3364dd;
33
$font-color: black;
44
$background-color: desaturate(#fcfaf3, 80%);
55

6+
@import url('https://fonts.googleapis.com/css?family=Roboto');
7+
@import url('https://fonts.googleapis.com/css?family=Ubuntu+Mono');
8+
69
body {
710
margin: 0 auto;
811
max-width: 50em;
9-
font-family: 'Helvetica', serif;
12+
font-family: -apple-system, 'Roboto', serif;
1013
background-color: $background-color;
1114

1215
line-height: 1.5;
@@ -16,6 +19,7 @@ body {
1619
code {
1720
color: $primary-color;
1821
background-color: white;
22+
font-family: "Ubuntu Mono";
1923
}
2024

2125
// Override bootstrap.
@@ -36,12 +40,4 @@ a.button {
3640
text-decoration: none;
3741
color: initial;
3842
padding: 3px;
39-
}
40-
41-
// Hugo Table of Contents
42-
nav ul {
43-
padding-inline-start: 0px;
44-
}
45-
nav li {
46-
padding-inline-start: 15px;
4743
}

site/themes/sail/layouts/doc/single.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h1>Sail Documentation</h1>
4949
</ul>
5050
</dl>
5151
</div>
52-
<div class="col-lg">
52+
<div class="col-lg content-box">
5353
<h1> {{ .Title }} </h1>
5454
{{ .Content }}
5555
</div>

0 commit comments

Comments
 (0)