actions/mark
1
0
Fork 0
mirror of https://github.com/kovetskiy/mark.git synced 2025-04-23 21:32:41 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

documentation about dry-run mode

Browse Source
This commit is contained in:
Egor Kovetskiy 2015-09-20 00:58:49 +06:00
parent bf19b9124d
commit 5838b5d6eb
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,20 +1,21 @@
# Mark
Mark it's tool for syncing your markdown documentation with Atlassian Confluence pages.
Mark it's tool for syncing your markdown documentation with Atlassian
Confluence pages.
This is very usable if you store documentation to your orthodox software in git
repository and don't want to do a handjob with updating Confluence page using
fucking tinymce wysiwyg enterprise core editor.
You can store a user credentials in the configuration file, which should be
located in ~/.config/mark with following format:
located in `~/.config/mark` with following format:
```
username = "smith"
password = "matrixishere"
```
Mark can read Confluence page URL and markdown file path from another specified
configuration file, which you can specify using -c <file> flag. It is very
configuration file, which you can specify using `-c <file>` flag. It is very
usable for git hooks. That file should have following format:
```toml
url = "http://confluence.local/pages/viewpage.action?pageId=123456"
@ -23,8 +24,8 @@ file = "docs/README.md"
## Usage:
```
mark [-u <username>] [-p <password>] -l <url> -f <file>
mark [-u <username>] [-p <password>] -c <file>
mark [--dry-run] [-u <username>] [-p <password>] -l <url> -f <file>
mark [--dry-run] [-u <username>] [-p <password>] -c <file>
mark -v | --version
mark -h | --help
```
@ -33,6 +34,8 @@ mark -h | --help
- `-p <password>` - Use specified password for updating Confluence page.
- `-l <url>` - Edit specified Confluence page.
- `-f <file>` - Use specified markdown file for converting to html.
- `-c <file>` - Specify configuration file which should be used for reading Confluence page URL and markdown file path.
- `-c <file>` - Specify configuration file which should be used for reading
Confluence page URL and markdown file path.
- `--dry-run` - Show resulting HTML and don't update Confluence page content.
- `-v | --version` - Show version.
- `-h | --help` - Show help screen and call 911.