-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.dbl.txt
50 lines (30 loc) · 991 Bytes
/
README.dbl.txt
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
38
39
40
41
42
43
44
45
46
47
48
49
[meta]
- Title: DoubleDown - README
- Author: krisds
# DoubleDown
[image logo.svg width 50%]
See <<doubledown.dbl.txt>>[link doubledown.dbl.txt] (or <<the HTML
version>>[link doubledown.html]) for an overview of the DoubleDown syntax.
## Installing
1. Install <<node.js>>[link https://nodejs.org/en/].
2. Run:
[code]
> npm install
3. Set up your path to include the `dbldwn/` folder.
## Using
Just create a text file containing DoubleDown markup. No specific extension
required, but please use `.dbl.txt` for clarity.
### HTML
To convert a file to HTML:
[code]
> dbldwn --in <your file> --as html --out <html file>
### JSON
To convert a file to JSON:
[code]
> dbldwn --in <your file> --as json --out <json file>
### Markdown
To convert a file to Markdown:
[code]
> dbldwn --in <your file> --as md --out <markdown file>
**Note:** Markdown conversion is currently incomplete. By design it may also
be lossy, depending on the input document.