https://github.com/romnn/embedme

Utility for embedding code snippets into markdown documents
https://github.com/romnn/embedme

Last synced: 18 days ago
JSON representation

Utility for embedding code snippets into markdown documents

• Host: GitHub
• URL: https://github.com/romnn/embedme
• Owner: romnn
• License: mit
• Created: 2022-11-05T00:50:09.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-18T17:09:26.000Z (over 1 year ago)
• Last Synced: 2025-01-19T08:43:40.978Z (12 months ago)
• Language: Go
• Size: 55.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## embedme

[![Build Status](https://github.com/romnn/embedme/workflows/test/badge.svg)](https://github.com/romnn/embedme/actions)

[![GitHub](https://img.shields.io/github/license/romnn/embedme)](https://github.com/romnn/embedme)

[![Test Coverage](https://codecov.io/gh/romnn/embedme/branch/master/graph/badge.svg)](https://codecov.io/gh/romnn/embedme)

[![Release](https://img.shields.io/github/release/romnn/embedme)](https://github.com/romnn/embedme/releases/latest)

t.b.a

```bash

go install github.com/romnn/embedme/cmd/embedme

embedme serve --generate

```

You can also download pre-built [release binaries](https://github.com/romnn/embedme/releases).

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

### Development

#### Tools

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

```bash

$ 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:

```bash

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