Skip to content

Commit 22c23fd

Browse files
committed
Update doc
1 parent 4846967 commit 22c23fd

File tree

2 files changed

+13
-17
lines changed

2 files changed

+13
-17
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# pandoc-codeblock-include
1+
Installation
2+
============
3+
24
![Python package](https://github.com/chdemko/pandoc-codeblock-include/workflows/Python%20package/badge.svg?branch=develop)
35
[![Coveralls](https://img.shields.io/coveralls/github/chdemko/pandoc-codeblock-include/develop.svg?logo=Codecov&logoColor=white)](https://coveralls.io/github/chdemko/pandoc-codeblock-include?branch=develop)
46
[![Code Climate](https://codeclimate.com/github/chdemko/pandoc-codeblock-include/badges/gpa.svg)](https://codeclimate.com/github/chdemko/pandoc-codeblock-include/)
@@ -20,19 +22,7 @@ license icon by [Daniel Bruce](https://www.iconfinder.com/icons/216659/license_i
2022

2123
[pandoc]: http://pandoc.org/
2224

23-
Documentation
24-
-------------
25-
26-
See the [wiki pages](https://github.com/chdemko/pandoc-codeblock-include/wiki).
27-
28-
Usage
29-
-----
30-
31-
To apply the filter, use the following option with pandoc:
32-
33-
--filter pandoc-codeblock-include
34-
35-
Installation
25+
Instructions
3626
------------
3727

3828
*pandoc-codeblock-include* requires [python], a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed [on Windows]. Either python 2.7 or 3.x will do.

docs/usage.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
Usage
22
=====
33

4+
To apply the filter, use the following option with pandoc:
5+
6+
~~~shell
7+
$ pandoc --filter pandoc-codeblock-include
8+
~~~
9+
410
Explanation
511
-----------
612

@@ -14,6 +20,6 @@ Example
1420

1521
Demonstration: Using [pandoc-codeblock-include-sample.txt] as input gives output file in [pdf] (use [lorem] content).
1622

17-
[pandoc-codeblock-include-sample.txt]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/pandoc-codeblock-include-sample.txt
18-
[lorem]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/lorem
19-
[pdf]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/pandoc-codeblock-include-sample.pdf
23+
[pandoc-codeblock-include-sample.txt]: https://raw.githubusercontent.com/chdemko/pandoc-codeblock-include/develop/docs/images/pandoc-codeblock-include-sample.txt
24+
[lorem]: https://raw.githubusercontent.com/chdemko/pandoc-codeblock-include/develop/docs/images/lorem
25+
[pdf]: https://raw.githubusercontent.com/chdemko/pandoc-codeblock-include/develop/docs/images/pandoc-codeblock-include-sample.pdf

0 commit comments

Comments
 (0)