Add docs

chdemko · chdemko · commit 48469673aa28 · 2023-06-17T22:53:40.000+02:00
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,2 @@
+```{include} ../README.md
+```
diff --git a/docs/images/lorem b/docs/images/lorem
@@ -0,0 +1,5 @@
+Lorem ipsum dolor sit amet, consectetur adipiscing elit.
+Duis pretium rutrum dignissim.
+Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
+Interdum et malesuada fames ac ante ipsum primis in faucibus.
+Ut iaculis arcu sed dui ornare pretium.
diff --git a/docs/images/pandoc-codeblock-include-sample.pdf b/docs/images/pandoc-codeblock-include-sample.pdf
diff --git a/docs/images/pandoc-codeblock-include-sample.txt b/docs/images/pandoc-codeblock-include-sample.txt
@@ -0,0 +1,3 @@
+~~~ {include=lorem startFrom=2 endAt=3}
+~~~
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,10 @@
+Welcome to pandoc-codeblock-include's documentation!
+====================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents
+
+   Installation <README>
+   Usage <usage>
+
diff --git a/docs/usage.md b/docs/usage.md
@@ -0,0 +1,19 @@
+Usage
+=====
+
+Explanation
+-----------
+
+In the attributes of a `CodeBlock` element, you can specify an file to be included and the start and end lines using attributes:
+* `include` for the path of the included file
+* `startFrom` for the first line to include
+* `endAt` for the last line to include
+
+Example
+-------
+
+Demonstration: Using [pandoc-codeblock-include-sample.txt] as input gives output file in [pdf] (use [lorem] content).
+
+[pandoc-codeblock-include-sample.txt]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/pandoc-codeblock-include-sample.txt
+[lorem]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/lorem
+[pdf]: https://raw.githubusercontent.com/wiki/chdemko/pandoc-codeblock-include/images/pandoc-codeblock-include-sample.pdf

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+~~~ {include=lorem startFrom=2 endAt=3}`
	`2`	`+~~~`
	`3`	`+`