Usage Untracked

bock

A small personal Markdown and git-powered wiki I wrote to teach myself Go. You can see it in action here.

I have old Node and Python versions of this as well for giggles.

Usage

See the releases page for a few pre-built binaries.

Here’s how you can run from source:

# Clone repo
git clone https://github.com/afreeorange/bock.git

# Now point it at a git repository full of Markdown files
# and tell it where to generate the output. You need to use
# absolute paths for now.
go run --tags "fts5" . --in=/path/to/repo --out=/path/to/output --without-revisions

# If your article repository is managed by git, you can omit
# that last flag to generate ✨article revisions✨
go run --tags "fts5" . --in=/path/to/repo --out=/path/to/output

Add a --help flag to see some more options.

Terminology and Setup

An Entity is either

Other stuff:

That’s really about it.

What It Does

The first command in the “Usage” section will generate the following (using this article as an example):

A giant work in progress but works pretty well for me so far. Uses a baby implementation of Go’s WaitGroups so will be slow on older machines or those with less memory.

Upcoming Features

Other Notes

	go func() {
		for {
			log.Printf("Number of goroutines: %d", runtime.NumGoroutine())
			time.Sleep(1 * time.Second)
		}
	}()