Skip to content
Snippets Groups Projects
Verified Commit eacc8add authored by ck85nori's avatar ck85nori :railway_track:
Browse files

adds alternatives section

parent 1f0e7473
Branches
No related tags found
No related merge requests found
Pipeline #435 passed
Change to Document Title Here Pandoc Template
============================= ===============
A flexible and future proof way to write documents. A flexible and future proof way to write documents.
...@@ -29,12 +29,24 @@ The default features include: ...@@ -29,12 +29,24 @@ The default features include:
### Disabling Features ### Disabling Features
You can remove some features just by removing the respective content in the You can disable most features by just removing the respective content in the
Markdown sources. Markdown sources. Some feature are integrated in the `Makefile` for which you
need to perform additional steps:
- **plots:** remove the `*.R` file(s) in `img/plot` - **plots:** remove the `*.R` file(s) in `img/plot`
- **flowcharts:** remove the `*.dot` file(s) in `img/graph` - **flowcharts:** remove the `*.dot` file(s) in `img/graph`
### Alternatives
Most features and tools are optional **and** replaceable, the only real core
tool is [pandoc][]. Besides that, everything can be changed, e.g. you could use
a different programming language for plotting, you could use [Inkscape][] to
create and edit your flowcharts, or you could even use a different build tool.
If you have an idea, suggestion, or even a concrete example, feel free to [open
an issue][issue] or create a merge request. The more (optional) features we can
offer the more it shows how flexible and future proof this way of working is.
Continuous Integration Continuous Integration
---------------------- ----------------------
...@@ -58,9 +70,10 @@ integrated. See [this issue][spell-check-issue] for more information and ...@@ -58,9 +70,10 @@ integrated. See [this issue][spell-check-issue] for more information and
progress. progress.
If you think that the spell checker with its [current If you think that the spell checker with its [current
limitations][spell-check-issue] is more of an annoyance than help, you can limitations][spell-check-issue] is more of an annoyance than help and you can
disable it by removing the **check** stage from the `.gitlab-ci.yml` file. Once rely on the spell checking from your editor, you can disable it by removing the
the issues are fixed, you can simply re-enable it by reverting the commit. **check** stage from the `.gitlab-ci.yml` file. Once the issues are fixed, you
can simply re-enable it by [reverting the commit][git-revert].
### Deployment to Nextcloud ### Deployment to Nextcloud
...@@ -131,8 +144,8 @@ build the template PDF, you need these dependencies: ...@@ -131,8 +144,8 @@ build the template PDF, you need these dependencies:
- [pandoc and pandoc-citeproc][pandoc] - [pandoc and pandoc-citeproc][pandoc]
- LaTeX, either through **texlive** or **MiKTeX** - LaTeX, either through **texlive** or **MiKTeX**
- GNU **make** - GNU **make**
- [graphviz][] - [Graphviz][]
- R including the packages **data.table**, **tidyverse** and **svglite** - [R][] including the packages **data.table**, **tidyverse** and **svglite**
`install.packages(c("data.table", "tidyverse", "svglite"), Ncpus = 8)` `install.packages(c("data.table", "tidyverse", "svglite"), Ncpus = 8)`
- [watchexec][] - [watchexec][]
- [markdown-spellcheck][] - [markdown-spellcheck][]
...@@ -140,12 +153,16 @@ build the template PDF, you need these dependencies: ...@@ -140,12 +153,16 @@ build the template PDF, you need these dependencies:
**Note:** On MS Windows, it might be helpful using [chocolatey][]. **Note:** On MS Windows, it might be helpful using [chocolatey][].
[idiv-nc]: https://portal.idiv.de/nextcloud/
[spell-check-issue]: https://git.idiv.de/templates/pandoc/issues/3
[chocolatey]: https://chocolatey.org/ [chocolatey]: https://chocolatey.org/
[git]: https://git-scm.com/downloads [git]: https://git-scm.com/downloads
[graphviz]: https://graphviz.gitlab.io/download/ [git-revert]: https://git-scm.com/docs/git-revert
[Graphviz]: http://www.graphviz.org/download/
[idiv-nc]: https://portal.idiv.de/nextcloud/
[Inkscape]: https://inkscape.org/
[issue]: https://git.idiv.de/templates/pandoc/issues/new
[markdown-spellcheck]: https://www.npmjs.com/package/markdown-spellcheck [markdown-spellcheck]: https://www.npmjs.com/package/markdown-spellcheck
[pandoc]: https://pandoc.org/installing.html [pandoc]: https://pandoc.org/installing.html
[R]: https://www.r-project.org/
[spell-check-issue]: https://git.idiv.de/templates/pandoc/issues/3
[watchexec]: https://github.com/watchexec/watchexec/releases [watchexec]: https://github.com/watchexec/watchexec/releases
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment