Initial commit

VCCPlindsten · Jan 22, 2022 · a08467c · a08467c
commit a08467c
Show file tree

Hide file tree

Showing 5 changed files with 737 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+Copyright 2022 Casey Marshall
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.md b/README.md
@@ -0,0 +1,28 @@
+# greenroom
+
+> What is this all about now?
+
+Rendering godocs for Backstage TechDocs documentation.
+
+greenroom renders [Godoc](https://go.dev/blog/godoc) comments into
+documentation that can be consumed and rendered into Backstage using its
+[TechDocs plugin](https://backstage.io/docs/features/techdocs/creating-and-publishing).
+TechDocs expects a [Mkdocs](https://www.mkdocs.org/) project documentation
+configuration and layout.
+
+> Why would I want to do that?
+
+This makes it easy to upload your Go libraries' code documentation up into
+Backstage.
+
+It's not really that useful for public Go packages; just link to
+[pkg.go.dev](https://pkg.go.dev) for that. It'll be primarily useful for
+distributing internal Go packages within an organization that is using
+Backstage as an internal catalog of all the technical things.
+
+> How does it work?
+
+[github.com/princjef/gomarkdoc](https://github.com/princjef/gomarkdoc) is doing
+almost all of the real work, by rendering all the godocs into Markdown. Other
+than that its just a bit of Go package introspection, YAML wrangling and
+shuffling files around.
diff --git a/go.mod b/go.mod
@@ -0,0 +1,44 @@
+module github.com/cmars/greenroom
+
+go 1.17
+
+require (
+	github.com/ghodss/yaml v1.0.0
+	github.com/princjef/gomarkdoc v0.3.1
+	golang.org/x/tools v0.1.8
+)
+
+require (
+	github.com/Microsoft/go-winio v0.5.0 // indirect
+	github.com/VividCortex/ewma v1.2.0 // indirect
+	github.com/cheggaaa/pb/v3 v3.0.8 // indirect
+	github.com/emirpasic/gods v1.12.0 // indirect
+	github.com/fatih/color v1.11.0 // indirect
+	github.com/go-git/gcfg v1.5.0 // indirect
+	github.com/go-git/go-billy/v5 v5.3.1 // indirect
+	github.com/go-git/go-git/v5 v5.3.0 // indirect
+	github.com/imdario/mergo v0.3.12 // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/kevinburke/ssh_config v1.1.0 // indirect
+	github.com/mattn/go-colorable v0.1.8 // indirect
+	github.com/mattn/go-isatty v0.0.12 // indirect
+	github.com/mattn/go-runewidth v0.0.12 // indirect
+	github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/princjef/mageutil v0.1.0 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
+	github.com/russross/blackfriday/v2 v2.1.0 // indirect
+	github.com/sergi/go-diff v1.2.0 // indirect
+	github.com/sirupsen/logrus v1.8.1 // indirect
+	github.com/x-cray/logrus-prefixed-formatter v0.5.2 // indirect
+	github.com/xanzy/ssh-agent v0.3.0 // indirect
+	golang.org/x/crypto v0.0.0-20210513164829-c07d793c2f9a // indirect
+	golang.org/x/mod v0.5.1 // indirect
+	golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f // indirect
+	golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 // indirect
+	golang.org/x/term v0.0.0-20210503060354-a79de5458b56 // indirect
+	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
+	mvdan.cc/xurls/v2 v2.2.0 // indirect
+)