Skip to content

Commit

Permalink
Default config and updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
philmacfly committed Nov 12, 2023
1 parent 63f7f73 commit 4501c64
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# seilfahrt

Tool to create a wiki page from a HedgeDoc

## Prerequisites

You must have pandoc installed and in your PATH variable for this to work!

## Usage

Create a config file with your access tokens and wiki settings and put it next to the executable.
Afterwards simply execute the executable with the -id command line flage and append the id of the Hedgedoc pad.

### Command Line Parameters

| Parameter | Description | Default Value |
|-----------|----------------------------------------------------------|---------------|
| id | The ID of the hedgedoc pad to be dowloaded and converted | |
| c | The path to the config file | ./config.toml |
| h | If active prints all command line args | |
7 changes: 7 additions & 0 deletions config/config.toml.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
HedgedocURL = "https://hedgedoc.nerdberg.de"
WikiURL = "https://wiki.nerdberg.de/api.php"
ConsumerToken = ""
ConsumerSecret = ""
AccessToken = ""
AccessSecret = ""
PlenenPageId = "28"

0 comments on commit 4501c64

Please sign in to comment.