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

Format Markdown files with Markdownlint #851

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

nschonni
Copy link
Contributor

Took a quick pass over the files with Markdownlint-CLI2. Still 2 left over in docs/index.md for HTML elements.

Basic config of

{
    "config": {
        "default": true,
        "MD013": false
    }
}

Leaves the last 2 messages:

$ markdownlint-cli2-fix "**/*.md"
markdownlint-cli2-fix v0.6.0 (markdownlint v0.27.0)
Finding: **/*.md
Linting: 22 file(s)
Summary: 2 error(s)
docs/index.md:3:1 MD033/no-inline-html Inline HTML [Element: a]
docs/index.md:3:41 MD033/no-inline-html Inline HTML [Element: img]

Still 2 left over in docs/index.md for HTML elements
@ohler55
Copy link
Owner

ohler55 commented Feb 27, 2023

The docs directory looks like an experiment that didn't pan out so it can be removed.

@nschonni
Copy link
Contributor Author

I think those files are for the GitHub pages https://ohler55.github.io/oj/
Do you want me to remove the files and the _config.yml in the root? You'd probably need to turn off the Pages in the repo settings too

@ohler55
Copy link
Owner

ohler55 commented Feb 27, 2023

I see, should probably leave them in place until I have a changes to see if GitHub Pages is being used or not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants