Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
pandoc
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
templates
pandoc
Commits
eacc8add
Verified
Commit
eacc8add
authored
6 years ago
by
ck85nori
Browse files
Options
Downloads
Patches
Plain Diff
adds alternatives section
parent
1f0e7473
Branches
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#435
passed
6 years ago
Stage: check
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+29
-12
29 additions, 12 deletions
README.md
with
29 additions
and
12 deletions
README.md
+
29
−
12
View file @
eacc8add
Change to Document Title Her
e
Pandoc Templat
e
===============
==============
===============
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**
- [
g
raphviz][]
- [
G
raphviz][]
-
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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment