rakali 0.0.17 → 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +66 -0
- data/lib/rakali/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f100f7c3e9f272f29ae6d04f4d6bfd6c08503e01
|
|
4
|
+
data.tar.gz: 6b910f09126fc3fb6208c304d77f230b6ce6e7fd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7e29cc1e99f2bd1e4980369da3f7c4766fec28df424092a4639ab767a82df89274de9f371cb7f6908167a97ef255f75e4739094b1ebc7eb5b6bb04d3f2a879e7
|
|
7
|
+
data.tar.gz: f0072b709f8462dbc88e4e430f10484b26a552d23c9204516a56e96e8aaf1ed91e226002988f11b6e2909a2941b29b1712a1883f109e62bb8592fbf3b22b0a51
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
|
@@ -4,3 +4,69 @@ rakali.rb
|
|
|
4
4
|
[](https://travis-ci.org/rakali/rakali.rb)
|
|
5
5
|
[](http://badge.fury.io/rb/rakali)
|
|
6
6
|
[](https://codeclimate.com/github/rakali/rakali.rb)
|
|
7
|
+
|
|
8
|
+
Rakali is a wrapper for the [Pandoc](http://johnmacfarlane.net/pandoc/) document converter with the following features:
|
|
9
|
+
|
|
10
|
+
* bulk conversion of all files in a folder with a specific extension, e.g. `.md`.
|
|
11
|
+
* input via a configuration file in yaml format instead of via the command line
|
|
12
|
+
* validation of documents via [JSON Schema](http://json-schema.org/), using the [json-schema](https://github.com/hoxworth/json-schema) Ruby gem.
|
|
13
|
+
* Logging via `stdout` and `stderr`.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
gem install rakali
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Use
|
|
22
|
+
|
|
23
|
+
Provide a configuration file in yaml format as input:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
rakali convert .rakali.yml
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
The default configuration looks like this:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
from:
|
|
33
|
+
folder:
|
|
34
|
+
format: md
|
|
35
|
+
to:
|
|
36
|
+
format: html
|
|
37
|
+
schema: default.json
|
|
38
|
+
citations: false
|
|
39
|
+
strict: false
|
|
40
|
+
merge: false
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The only required key for the input yaml file is `from` `folder`, and you can override any key in the default file.
|
|
44
|
+
|
|
45
|
+
* **schema**: JSON schema used for validation. Use `your_folder/schema.json` for a custom schema, or use one of the built-in schemata (see [pandoc-schemata](https://github.com/rakali/pandoc-schemata) for a list.)
|
|
46
|
+
* **citations**: include `-f citeproc-pandoc` for citation formatting
|
|
47
|
+
* **strict**: abort conversion on validation errors
|
|
48
|
+
* **merge**: merge all input files into a single file
|
|
49
|
+
|
|
50
|
+
To integrate rakali into a continuous integration environment such as [Travis CI](https://travis-ci.org), add a configuration file (e.g. `.rakali.yml`) into the root folder of your repo and include the following line in your `.travis.yml` file:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
language: haskell
|
|
54
|
+
script:
|
|
55
|
+
- gem install rakali
|
|
56
|
+
- rakali convert .rakali.yml
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Feedback
|
|
60
|
+
|
|
61
|
+
This is an early release version. Please provide feedback via the [issue tracker](https://github.com/rakali/rakali.rb/issues).
|
|
62
|
+
|
|
63
|
+
## Contributing
|
|
64
|
+
|
|
65
|
+
1. Fork it
|
|
66
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
67
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
68
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
|
69
|
+
5. Create new Pull Request
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
[MIT License](LICENSE).
|
data/lib/rakali/version.rb
CHANGED