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
b6b49d5a
Verified
Commit
b6b49d5a
authored
6 years ago
by
ck85nori
Browse files
Options
Downloads
Patches
Plain Diff
adds getting started and toc to readme
this finishes improve readme sprint fixes
#6
parent
2df821ab
No related branches found
No related tags found
No related merge requests found
Pipeline
#458
passed
6 years ago
Stage: check
Stage: build
Stage: deploy
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+35
-9
35 additions, 9 deletions
README.md
with
35 additions
and
9 deletions
README.md
+
35
−
9
View file @
b6b49d5a
Pandoc Template
Pandoc
Project
Template
===============
===============
========
A flexible and future proof way to write documents.
A flexible and future proof way to write documents.
<!-- toc -->
-
[
Getting Started
](
#getting-started
)
-
[
Features
](
#features
)
*
[
Disabling Features
](
#disabling-features
)
*
[
Alternatives
](
#alternatives
)
-
[
Continuous Integration
](
#continuous-integration
)
*
[
Spell Checking
](
#spell-checking
)
*
[
Deployment to Nextcloud
](
#deployment-to-nextcloud
)
-
[
Building
](
#building
)
*
[
Requirements
](
#requirements
)
-
[
Alternative To Project Template
](
#alternative-to-project-template
)
<!-- tocstop -->
Getting Started
---------------
First, you need to
[
create a new project
](
https://git.idiv.de/projects/new
)
.
Choose
**Create from template**
,
**Instance**
and finally
**pandoc**
. Choose a
project name and create the project. Clone the project to your local machine
and start editing the Markdown sources. See below for features, using the build
server and how to build locally.
Features
Features
--------
--------
...
@@ -124,16 +148,18 @@ first by following these steps:
...
@@ -124,16 +148,18 @@ first by following these steps:
Building
Building
--------
--------
To build the PDF, just type
`make`
. Make already does incremental compilation,
To build the PDF locally, you need to run the build script. Open a terminal,
i.e. it re-compiles only those targets whose sources changed. If you want to
change to the cloned project directory and type
`make`
. Make already does
watch for changes and automatically run
`make`
when something changes, use
incremental compilation, i.e. it re-compiles only those targets whose sources
[
watchexec][
]:
changed. If you want to watch for changes and automatically run
`make`
when
something changes, use
[
watchexec
][]
:
```
```
watchexec make
watchexec make
```
```
The `watchexec` tool honors `.gitignore`.
**Note:**
The
`watchexec`
tool honors
`.gitignore`
so it doesn't run the
command when the targets changed but only if the sources do.
### Requirements
### Requirements
...
@@ -150,8 +176,8 @@ build the template PDF, you need these dependencies:
...
@@ -150,8 +176,8 @@ build the template PDF, you need these dependencies:
-
[
watchexec
][]
-
[
watchexec
][]
-
[
markdown-spellcheck
][]
-
[
markdown-spellcheck
][]
**Note:** On MS Windows, it might be helpful using [chocolatey][]
.
**Note:**
On MS Windows, it might be helpful using
[
chocolatey
][]
to install
some of the dependencies, e.g. GNU make and Graphviz.
[
chocolatey
]:
https://chocolatey.org/
[
chocolatey
]:
https://chocolatey.org/
...
...
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