public
/
chroma-markdown
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Flush out README

This commit is contained in:
Kevin Burke 2017-10-22 10:34:56 -07:00
parent e95ae00e83
commit 9022c437d7
No known key found for this signature in database
GPG Key ID: 24B0EF06511BA263
2 changed files with 28 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -1 +1,2 @@
/*.md /*.md
/releases

30
README.md
View File

@ -3,16 +3,22 @@
This binary compiles Markdown files into HTML. In particular, code blocks of the This binary compiles Markdown files into HTML. In particular, code blocks of the
following format: following format:
<pre><code> <pre><code># Section Title
```go ```go
fmt.Println("hello world") fmt.Println("hello world")
``` ```</code></pre>
</code></pre>
Will be parsed and compiled to HTML using [`chroma`, a tool for generating Will be parsed and compiled to HTML using [`chroma`, a tool for generating
syntax highlights][chroma]. The rest of the file will be compiled from markdown syntax highlights][chroma]. The rest of the file will be compiled from markdown
to HTML. to HTML.
```html
<h1>Section Title</h1>
<pre class="chroma"><span class="nx">fmt</span><span class="p">.</span><span class="nx">Println</span><span class="p">(</span><span class="s">&#34;hello world&#34;</span><span class="p">)</span>
</pre>
```
Input can be sent either on standard input or by specifying a filename at the Input can be sent either on standard input or by specifying a filename at the
command line. All outputs are printed to standard output, where they can be command line. All outputs are printed to standard output, where they can be
redirected to a file: redirected to a file:
@ -35,3 +41,21 @@ that prevents in-memory Markdown compilation.
[error]: https://github.com/russross/blackfriday/issues/403 [error]: https://github.com/russross/blackfriday/issues/403
[chroma]: https://github.com/alecthomas/chroma [chroma]: https://github.com/alecthomas/chroma
## Installation
Find your target operating system (darwin, windows, linux) and desired bin
directory, and modify the command below as appropriate:
curl --silent --location --output=/usr/local/bin/chroma-markdown https://github.com/kevinburke/chroma-markdown/releases/download/0.1/chroma-markdown-linux-amd64 && chmod 755 /usr/local/bin/chroma-markdown
The latest version is 0.1.
If you have a Go development environment, you can also install via source code:
```
go get -u github.com/kevinburke/chroma-markdown
```
This should place a `chroma-markdown` binary in `$GOPATH/bin`, so for me,
`~/bin/chroma-markdown`.