smark

command module
v0.0.0-...-08dbdac Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2018 License: MIT Imports: 14 Imported by: 0

README

sMark

sMark is a simple markup language built for humans, it is easy to read and write, you can get an introduction here

Installing

If you already have Golang installed you can get it throught go get (go get https://github.com/gSpera/sMark)

Otherwise you can downloa9d the prebuilt binary from Github

Usage

Use sMark - help to get a brief intruduction to all command parameters

Basicaly you could use sMark -i inputfile.sm -o output.html

The main output engine produces HTML but there are other output engines and you can make you own

Telegra.ph: sMark -i inputfile.sm -telegraph Prettifier: sMark -i inputfile.sm -prettify = output.sm

WIP

sMark is in a developing state, some functions are now documented and the code is not optimal

README.sm

The file you are viewing is a Markdown version of the file README.sm, there is no easy way to convert sMark to Markdown(you can write you own Output Engine), it is actualy compiled to HTML and then converted to Markdown This solution is not optimal but GitHub doesn't support sMark

Documentation

Overview

sMark is a markup language which aims to be human readble and more powerfull that competitor this is the official implementation which currently supports two output engines: HTML and Telegra.ph and a prettifier. Other engines can be implemented externally.

Directories

Path Synopsis
Package output manages the outputs engines This package is not standardized and differents Output Engines have different interface
Package output manages the outputs engines This package is not standardized and differents Output Engines have different interface
telegraph
Package telegraphout implements an Output Engine for Telegra.ph platform
Package telegraphout implements an Output Engine for Telegra.ph platform
Package parser contains all the code used to tokenize the input and parsing it.
Package parser contains all the code used to tokenize the input and parsing it.
Package token package contains all the data abound the tokens.
Package token package contains all the data abound the tokens.

Jump to

Keyboard shortcuts

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