-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.sm
37 lines (25 loc) · 1.14 KB
/
README.sm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
sMark
=====
sMark is a simple markup language built for humans, it is easy to read and write,
you can get an introduction "here"@"https:\\/\\/gSpera.github.io\\/sMark"
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"@"https:\/\/github.com\/gSpera\/sMark\/releases"
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