embedmd

command module
v0.0.0-...-c8060a0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 29, 2017 License: Apache-2.0 Imports: 9 Imported by: 0

README

embedmd

$ go get github.com/rakyl/embedmd
[embedmd]:# (file.go sample)

See the sample directory for an example.

Documentation

Overview

embedmd

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.

embedmd supports two flags: -d: will print the difference of the input file with what the output

would have been if executed.

-w: rewrites the given files rather than writing the output to the standard

output.

For more information on the format of the commands, read the documentation of the github.com/campoy/embedmd/embedmd package.

Directories

Path Synopsis
Package embedmd provides a single function, Process, that parses markdown searching for markdown comments.
Package embedmd provides a single function, Process, that parses markdown searching for markdown comments.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL