Skip to content
/ embedme Public

Utility for embedding code snippets into markdown documents

License

Notifications You must be signed in to change notification settings

romnn/embedme

Repository files navigation

embedme

Build Status GitHub Test Coverage Release

t.b.a

go install github.com/romnn/embedme/cmd/embedme
embedme serve --generate

You can also download pre-built release binaries.

For a list of options, run with --help.

Development

Tools

Before you get started, make sure you have installed the following tools:

$ python3 -m pip install pre-commit bump2version invoke
$ go install github.com/kyoh86/richgo@latest
$ go install golang.org/x/tools/cmd/goimports@latest
$ go install golang.org/x/lint/golint@latest
$ go install github.com/fzipp/gocyclo/cmd/gocyclo@latest

Please always make sure code checks pass:

inv pre-commit

TODO

  • add support for urls

  • add interface for filesystem accesses

  • add test

  • use different color library?

  • refactor the code

  • add a lot of tests!

  • fix the source line numbers

  • done

    • basic parsing
    • add regex that can identify commands

About

Utility for embedding code snippets into markdown documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages