campoy / embedmd

embedmd

Are you tired of copy pasting your code into your README.md file, just to
forget about it later on and have unsynced copies? Or even worse, code
that does not even compile?

Then embedmd is for you!

embedmd embeds files or fractions of files into markdown files. It does
so by searching embedmd commands, which are a subset of the markdown
syntax for comments. This means they are invisible when markdown is
rendered, so they can be kept in the file as pointers to the origin of
the embedded text.

The command receives a list of markdown files, if none is given it reads
from the standard input.

The format of an embedmd command is:

[embedmd]:# (filename language /start regexp/ /end regexp/)

The embedded code will be extracted from the file filename, starting at the
first line that matches /start regexp/ and finishing at the first line
matching /end regexp/.

Ommiting the the second regular expression will embed only the piece of text
that matches /regexp/:

[embedmd]:# (filename language /regexp/)

To embed the whole line matching a regular expression you can use:

[embedmd]:# (filename language /.*regexp.*\n/)

If you want to embed from a point to the end you should use:

[embedmd]:# (filename language /start regexp/ $)

Finally you can embed a whole file by omitting both regular expressions:

[embedmd]:# (filename language)

You can ommit the language in any of the previous commands, and the extension
of the file will be used for the snippet syntax highlighting.

Note that while this works Go files, since the file extension .go matches the
name of the language go, this will fail with other fileslike .md whose
language name is markdown.

[embedmd]:# (file.ext)

Installation

embedmd is written in Go, so if you have Go installed (you can do so
by following these instructions) you can
install it with go get:

go get github.com/campoy/embedmd

This will download the code, compile it, and leave an embedmd binary
in $GOPATH/bin.

Eventually, and if there's enough interest, I will provide binaries for
every OS and architecture out there ... eventually.

Usage:

#A hello world in Go
Go is very simple, here you can see a whole "hello, world" program.
[embedmd]:# (hello.go)
You always start with a `package` statement like:
[embedmd]:# (hello.go /pack/)
Followed by an `import` statement:
[embedmd]:# (hello.go /import/ /\)/)
And finally, the `main` function:
[embedmd]:# (hello.go /func main/ $)