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

add a note about issues, bugs, and feature requests

Browse Source
This commit is contained in:
Egor Kovetskiy 2021-07-14 12:45:38 +03:00
parent 5d65fddd43
commit 2ea132f84d
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,4 +1,5 @@
# Mark # Mark
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat-square)](#contributors-) [![All Contributors](https://img.shields.io/badge/all_contributors-23-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> <!-- ALL-CONTRIBUTORS-BADGE:END -->
@ -339,7 +340,7 @@ mark -h | --help
- `-l <url>` — Edit specified Confluence page. - `-l <url>` — Edit specified Confluence page.
If -l is not specified, file should contain metadata (see above). If -l is not specified, file should contain metadata (see above).
- `-b <url>` or `--base-url <url>` – Base URL for Confluence. - `-b <url>` or `--base-url <url>` – Base URL for Confluence.
Alternative option for base_url config field. Alternative option for `base_url` config field.
- `-f <file>` — Use specified markdown file(s) for converting to html. Supports file globbing patterns (needs to be quoted). - `-f <file>` — Use specified markdown file(s) for converting to html. Supports file globbing patterns (needs to be quoted).
- `-c <file>` — Specify configuration file which should be used for reading - `-c <file>` — Specify configuration file which should be used for reading
Confluence page URL and markdown file path. Confluence page URL and markdown file path.
@ -417,6 +418,22 @@ Rather than running `mark` multiple times, or looping through a list of files fr
```bash ```bash
mark -f "helpful_cmds/*.md" mark -f "helpful_cmds/*.md"
``` ```
## Issues, Bugs & Contributions
I've started the project to solve my own problem and open sourced the solution so anyone who has a problem like me can solve it too.
I have no profits/sponsors from this projects which means I don't really prioritize working on this project in my free time.
I still check the issues and do code reviews for Pull Requests which means if you encounter a bug in
the program, you should not expect me to fix it as soon as possible, but I'll be very glad to
merge your own contributions into the project and release the new version.
I try to label all new issues so it's easy to find a bug or a feature request to fix/implement, if
you are willing to help with the project, you can use the following labels to find issues, just make
sure to reply in the issue to let everyone know you took the issue:
- [label:feature-request](https://github.com/kovetskiy/mark/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request)
- [label:bug](https://github.com/kovetskiy/mark/issues?q=is%3Aissue+is%3Aopen+label%3Abug)
## Contributors ✨ ## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):