Skip to content

Commit ec1e0fb

Browse files
committed
Updated README
1 parent d026f10 commit ec1e0fb

File tree

1 file changed

+13
-51
lines changed

1 file changed

+13
-51
lines changed

README.md

Lines changed: 13 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,6 @@ func main() {
8383
fmt.Println("Hello World")
8484
}
8585
```
86-
> *source: docs/quickstart/src/hello/main.go:example*
87-
8886

8987
A `snippet` is not required in your `code` tag. The default behavior of a `code` tag is to include the entire source file.
9088

@@ -98,10 +96,10 @@ import "fmt"
9896
func main() {
9997
fmt.Println("Hello World")
10098
}
101-
```
102-
> *source: docs/quickstart/src/hello/main.go*
10399

104100

101+
```
102+
105103
Notice that none of the `snippet` comments were in the output? This is because hype recognizes them as directives for the document, and will not show them in the actual output.
106104

107105
# Go Specific Commands
@@ -127,7 +125,7 @@ $ go run .
127125
Hello World
128126

129127
--------------------------------------------------------------------------------
130-
Go Version: go1.23.0
128+
Go Version: go1.22.6
131129

132130
```
133131

@@ -148,10 +146,10 @@ import "fmt"
148146
func main() {
149147
fmt.Println("Hello World")
150148
}
151-
```
152-
> *source: docs/quickstart/src/hello/main.go*
153149

154150

151+
```
152+
155153
---
156154

157155
```shell
@@ -160,7 +158,7 @@ $ go run .
160158
Hello World
161159

162160
--------------------------------------------------------------------------------
163-
Go Version: go1.23.0
161+
Go Version: go1.22.6
164162

165163
```
166164

@@ -178,8 +176,6 @@ func main() {
178176
fmt.Println("Hello World")
179177
}
180178
```
181-
> *source: docs/quickstart/src/hello/main.go#example:example*
182-
183179

184180
---
185181

@@ -189,7 +185,7 @@ $ go run .
189185
Hello World
190186

191187
--------------------------------------------------------------------------------
192-
Go Version: go1.23.0
188+
Go Version: go1.22.6
193189

194190
```
195191

@@ -207,8 +203,6 @@ func main() {
207203
fmt.Prin("Hello World")
208204
}
209205
```
210-
> *source: docs/quickstart/src/broken/main.go#example:example*
211-
212206

213207
---
214208

@@ -219,7 +213,7 @@ $ go run .
219213
./main.go:7:6: undefined: fmt.Prin
220214

221215
--------------------------------------------------------------------------------
222-
Go Version: go1.23.0
216+
Go Version: go1.22.6
223217

224218
```
225219

@@ -256,7 +250,7 @@ type Context interface{ ... }
256250
func WithoutCancel(parent Context) Context
257251

258252
--------------------------------------------------------------------------------
259-
Go Version: go1.23.0
253+
Go Version: go1.22.6
260254

261255
```
262256
@@ -279,7 +273,7 @@ func WithCancel(parent Context) (ctx Context, cancel CancelFunc)
279273
call cancel as soon as the operations running in this Context complete.
280274

281275
--------------------------------------------------------------------------------
282-
Go Version: go1.23.0
276+
Go Version: go1.22.6
283277

284278
```
285279
@@ -346,9 +340,8 @@ The following code will parse the code/code.md and sourceable/sourceable.md docu
346340
<include src="code/code.md"></include>
347341

348342
<include src="sourceable/sourceable.md"></include>
349-
```
350-
> *source: docs/quickstart/includes.md*
351343

344+
```
352345
353346
---
354347
@@ -576,36 +569,6 @@ $ tree
576569
├── code_test.go
577570
├── comment.go
578571
├── comment_test.go
579-
├── dist
580-
│   ├── CHANGELOG.md
581-
│   ├── artifacts.json
582-
│   ├── config.yaml
583-
│   ├── hype_0.1.0_checksums.txt
584-
│   ├── hype_Darwin_arm64.tar.gz
585-
│   ├── hype_Darwin_x86_64.tar.gz
586-
│   ├── hype_Linux_arm64.tar.gz
587-
│   ├── hype_Linux_i386.tar.gz
588-
│   ├── hype_Linux_x86_64.tar.gz
589-
│   ├── hype_Windows_arm64.zip
590-
│   ├── hype_Windows_i386.zip
591-
│   ├── hype_Windows_x86_64.zip
592-
│   ├── hype_darwin_amd64_v1
593-
│   │   └── hype
594-
│   ├── hype_darwin_arm64
595-
│   │   └── hype
596-
│   ├── hype_linux_386
597-
│   │   └── hype
598-
│   ├── hype_linux_amd64_v1
599-
│   │   └── hype
600-
│   ├── hype_linux_arm64
601-
│   │   └── hype
602-
│   ├── hype_windows_386
603-
│   │   └── hype.exe
604-
│   ├── hype_windows_amd64_v1
605-
│   │   └── hype.exe
606-
│   ├── hype_windows_arm64
607-
│   │   └── hype.exe
608-
│   └── metadata.json
609572
├── docs
610573
│   ├── badges.md
611574
│   ├── license.md
@@ -1266,7 +1229,7 @@ $ tree
12661229
├── var.go
12671230
└── var_test.go
12681231
1269-
322 directories, 581 files
1232+
313 directories, 560 files
12701233
```
12711234
---
12721235
@@ -1326,9 +1289,8 @@ jobs:
13261289
git config user.email '[email protected]'
13271290
git diff --quiet || (git add README.md && git commit -am "Updated README")
13281291
git push origin ${{github.event.pull_request.head.ref}}
1329-
```
1330-
> *source: .github/workflows/hype.yml*
13311292
1293+
```
13321294
13331295
---
13341296

0 commit comments

Comments
 (0)