Commit 0e51c74b authored by Ma_124's avatar Ma_124

improved README

parent 4fcc776b
Pipeline #53705666 passed with stages
in 2 minutes and 27 seconds
......@@ -17,16 +17,18 @@ It can convert [different filetypes](#filetypes) into each other and [fetch meta
`awesome.yml`:
```yaml
#!/usr/bin/env awesome compile --config
lists:
- input: "inplist.md"
format: "md:list"
outputs:
- file: "outlist.md"
format: "md:table+meta"
- file: "index.html"
format: "html:table+meta"
- file: "/dev/stdout"
format: "test-alpha"
- file: "outlist.html"
format: "html:table+meta"
```
`post-build.awesome.sh`:
......@@ -50,7 +52,7 @@ cat <<-EOF > public/index.html
## Filetypes
### `markdown` (Input)
### `md:list` (Input)
```md
+ lots
......@@ -62,17 +64,25 @@ cat <<-EOF > public/index.html
## Another Category
```
### `markdown` (+ `-html`) (Output)
TODO: describe parameters
```md
| Stars | Forks | Issues | Last Commit | Name | Desc |
|---------|---------|----------|---------------|-----------------|--------|
| <stars> | <forks> | <issues> | <last commit> | [<name>](<url>) | <desc> |
### `tabsep` (Input/Output)
```html
"literal line
'literal without newline
" continuation of previous line
<name>\t<url>\t<desc>
"""
block literal
which spans over
multiple lines
"""
```
If you append `-html` the markdown will be compiled with [Blackfriday][].
TODO: describe parameters
### `markdown-simple` (+ `-html`) (Output)
### `md:table` (+ `>html`) (Output)
```md
| Name | Desc |
......@@ -80,9 +90,19 @@ If you append `-html` the markdown will be compiled with [Blackfriday][].
| [<name>](<url>) | <desc> |
```
If you append `-html` the markdown will be compiled with [Blackfriday][].
If you append `>html` the markdown will be compiled with [Blackfriday][].
### `md:table+meta` (+ `>html`) (Output)
```md
| Stars | Forks | Issues | Last Commit | Name | Desc |
|---------|---------|----------|---------------|-----------------|--------|
| <stars> | <forks> | <issues> | <last commit> | [<name>](<url>) | <desc> |
```
If you append `>html` the markdown will be compiled with [Blackfriday][].
### `html` (Output)
### `html:table+meta` (Output)
```html
<html>
......@@ -99,19 +119,10 @@ If you append `-html` the markdown will be compiled with [Blackfriday][].
</html>
```
### `tabsep` (Input/Output)
```
"literal line
'literal without newline
" continuation of previous line
<name>\t<url>\t<desc>
"""
block literal
which spans over
multiple lines
"""
```
### `test:alpha` (Test)
Tests whether the items are in alphabetically order.
## Fetch Metadata
......
#!/usr/bin/env go run ../main.go compile --config
lists:
- input: "inplist.md"
format: "md:list"
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment