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

[Docs] Add markdownlint #2852

Merged
merged 2 commits into from
Aug 11, 2023
Merged

[Docs] Add markdownlint #2852

merged 2 commits into from
Aug 11, 2023

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Aug 8, 2023

Add popular tool markdownlint-cli which runs markdownlint via a package.json script for documentation formatting consistency and best practices.

The majority of these changes were autofixed.

More info in this related PR:

There's a good markdownlint VSCode extension which highlights and autofixes these issues as well: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

This will make it easier and safer to edit docs going forward.

docs/rules/no-import-module-exports.md Outdated Show resolved Hide resolved
docs/rules/no-unused-modules.md Outdated Show resolved Hide resolved
docs/rules/prefer-default-export.md Outdated Show resolved Hide resolved
resolvers/README.md Outdated Show resolved Hide resolved
resolvers/README.md Outdated Show resolved Hide resolved
resolvers/README.md Outdated Show resolved Hide resolved
resolvers/README.md Outdated Show resolved Hide resolved
resolvers/README.md Outdated Show resolved Hide resolved
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@ljharb
Copy link
Member

ljharb commented Aug 9, 2023

hmm, it seems like the node 4 build is failing; does markdownlint-cli depend on something that uses aliases? if it's bringing in jackspeak then that'll need to be pinned.

@ljharb ljharb self-assigned this Aug 10, 2023
@ljharb ljharb merged commit 2e7612f into import-js:main Aug 11, 2023
167 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants