Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test pr #258

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions `}); console.log('123') ; console.log({a:`.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://example.com/some%29page)
[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)

[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markdown-checker/issues}\\))aaaaa
[Link with parentheses](https://example.com/some%29page)

[Link with parentheses](https://example.com/some%29page)
[![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://github.com/john0isaac/markdown-checker/pulls)

[aa](./aaaaa
markdown-checker is a markdown validation reporting tool.

# How To
1. Run `pip install markdown-checker`.
2. Run `markdown-checker -d {src} -f {func}`. Replace `{src}` with the directory you want to analyse and {func} wit
h the available functions like check_broken_paths.
3. The output will be displayed in the terminal.

# Using markdown-checker in GitHub Actions
The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/
marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to you
r GitHub pull request as a comment.
19 changes: 19 additions & 0 deletions `}); console.log('pwn') ; console.log({a:`.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://example.com/some%29page)
[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markd
own-checker/issues}\\))aaaaa
[Link with parentheses](https://example.com/some%29page)
[Link with parentheses](https://example.com/some%29page)
[![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://github.com/john0isaac/markdown-ch
ecker/pulls)
[aa](./aaaaa
markdown-checker is a markdown validation reporting tool.
# How To
1. Run `pip install markdown-checker`.
2. Run `markdown-checker -d {src} -f {func}`. Replace `{src}` with the directory you want to analyse and {func} wit
h the available functions like check_broken_paths.
3. The output will be displayed in the terminal.
# Using markdown-checker in GitHub Actions
The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/
marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to you
r GitHub pull request as a comment
Loading