forked from tslocum/godoc-static
Add code.rocketnine.space migration notice
This commit is contained in:
parent
25611b612c
commit
6c091298c0
|
@ -1,26 +0,0 @@
|
|||
image: golang:latest
|
||||
|
||||
stages:
|
||||
- validate
|
||||
- build
|
||||
|
||||
fmt:
|
||||
stage: validate
|
||||
script:
|
||||
- gofmt -l -s -e .
|
||||
- exit $(gofmt -l -s -e . | wc -l)
|
||||
|
||||
vet:
|
||||
stage: validate
|
||||
script:
|
||||
- go vet -composites=false ./...
|
||||
|
||||
test:
|
||||
stage: validate
|
||||
script:
|
||||
- go test -race -v ./...
|
||||
|
||||
build:
|
||||
stage: build
|
||||
script:
|
||||
- go build
|
17
README.md
17
README.md
|
@ -1,5 +1,12 @@
|
|||
!!! cbind has moved to [code.rocketnine.space](https://code.rocketnine.space/tslocum/godoc-static) !!!
|
||||
====
|
||||
|
||||
Please visit https://code.rocketnine.space/tslocum/godoc-static
|
||||
|
||||
------------
|
||||
|
||||
# godoc-static
|
||||
[![CI status](https://gitlab.com/tslocum/godoc-static/badges/master/pipeline.svg)](https://gitlab.com/tslocum/godoc-static/commits/master)
|
||||
[![CI status](https://code.rocketnine.space/tslocum/godoc-static/raw/branch/master/badge.svg)](https://code.rocketnine.space/tslocum/godoc-static/commits/master)
|
||||
[![Donate](https://img.shields.io/liberapay/receives/rocketnine.space.svg?logo=liberapay)](https://liberapay.com/rocketnine.space)
|
||||
|
||||
Generate static Go documentation
|
||||
|
@ -13,7 +20,7 @@ Generate static Go documentation
|
|||
Install `godoc-static`:
|
||||
|
||||
```bash
|
||||
go get gitlab.com/tslocum/godoc-static
|
||||
go get code.rocketnine.space/tslocum/godoc-static
|
||||
```
|
||||
|
||||
Also install `godoc`:
|
||||
|
@ -40,14 +47,14 @@ Packages are not downloaded/updated automatically.
|
|||
|
||||
### Usage examples
|
||||
|
||||
Generate documentation for `archive`, `net/http` and `~/go/src/gitlab.com/tslocum/cview`:
|
||||
Generate documentation for `archive`, `net/http` and `~/go/src/code.rocketnine.space/tslocum/cview`:
|
||||
|
||||
```bash
|
||||
godoc-static \
|
||||
-site-name="Rocket Nine Labs Documentation" \
|
||||
-site-description-file=/home/user/sitefiles/description.md \
|
||||
-destination=/home/user/sites/docs \
|
||||
archive net/http gitlab.com/tslocum/cview
|
||||
archive net/http code.rocketnine.space/tslocum/cview
|
||||
```
|
||||
|
||||
### Options
|
||||
|
@ -87,4 +94,4 @@ Site ZIP file name.
|
|||
|
||||
## Support
|
||||
|
||||
Please share issues and suggestions [here](https://gitlab.com/tslocum/godoc-static/issues).
|
||||
Please share issues and suggestions [here](https://code.rocketnine.space/tslocum/godoc-static/issues).
|
||||
|
|
2
go.mod
2
go.mod
|
@ -1,4 +1,4 @@
|
|||
module gitlab.com/tslocum/godoc-static
|
||||
module code.rocketnine.space/tslocum/godoc-static
|
||||
|
||||
go 1.15
|
||||
|
||||
|
|
4
page.go
4
page.go
|
@ -20,7 +20,7 @@ summary { margin-left: 20px; cursor: pointer; }
|
|||
#footer > p, #footer > li { max-width: none; word-wrap: normal; }
|
||||
`
|
||||
|
||||
const footerText = `Generated by <a href="https://godoc.org/golang.org/x/tools/godoc" target="_blank">godoc</a> + <a href="https://gitlab.com/tslocum/godoc-static" target="_blank">godoc-static</a>`
|
||||
const footerText = `Generated by <a href="https://godoc.org/golang.org/x/tools/godoc" target="_blank">godoc</a> + <a href="https://code.rocketnine.space/tslocum/godoc-static" target="_blank">godoc-static</a>`
|
||||
|
||||
func topBar(basePath string, siteName string) string {
|
||||
var index string
|
||||
|
@ -88,7 +88,7 @@ func updatePage(doc *goquery.Document, basePath string, siteName string) {
|
|||
browseInsert = "/-/tree/master"
|
||||
} else if strings.HasPrefix(importPath, "github.com/") || strings.HasPrefix(importPath, "git.sr.ht/") {
|
||||
browseInsert = "/tree/master"
|
||||
} else if strings.HasPrefix(importPath, "bitbucket.org/") {
|
||||
} else if strings.HasPrefix(importPath, "bitbucket.org/") || strings.HasPrefix(importPath, "code.rocketnine.space/") {
|
||||
browseInsert = "/src/master"
|
||||
}
|
||||
if browseInsert != "" {
|
||||
|
|
Loading…
Reference in New Issue