Skip to content
Enaml - Markup to HTML Translator
Go HTML Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
examples
scripts
test
.gitignore
.travis.yml
LICENSE
README.md
enaml.go
enaml_test.go
linux-test.sh
win-test.bat

README.md

enaml Build Status Go Report Card Golang Version License: GPL v3

Enaml is Not A Markup Language

Enaml is a markup renderer, that uses a simplified markup language similar to GFM and can convert it to HTML files for easy viewing later. See the examples under examples for more.

Enaml was originally made for a user to take efficient notes quickly using this simplified markup syntax and be able to easiy render them en masse to HTML.

Getting Started

Here's how to set up enaml on your computer.

Prerequisites

  1. Install go-1.6 or later on your OS of choice and make sure the go executable is in your PATH.

  2. Download the latest master, and extract the zip or tarball

Building

Windows

  1. Run
$ go build

in the root directory of enaml.

  1. You should now see an enaml.exe in the directory.

Linux/OSX

  1. Run
$ go build

in the root directory of enaml.

  1. You should now see an enaml binary in the directory.

Running the Tests

Run the full test suite, benchmarks, and check code coverage by running either win-test.bat on windows or linux-run.sh on linux in the root directory. One does not exist for OSX yet.

In addition, you could also run go test in the root enaml directory.

Examples

The examples folder has many examples. The file syntax by example.enaml details the whole syntax for the enaml-interpretable markup language. By running

$ enaml.exe "examples\syntax by example.enaml"

on windows or

$ enaml "examples/syntax by example.enaml"

on linux/osx, you will generate a rendered enaml file as html in the examples directory.

License

GPL

This code is released under the GNU GENERAL PUBLIC LICENSE. All works in this repository are meant to be utilized under this license. You are entitled to remix, remodify, and redistribute this program as you see fit, under the condition that all derivative works must use the GPL Version 3.

Acknowledgments

A big thank you to the Github Markdown CSS project. The CSS is really nice.

You can’t perform that action at this time.