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.

Sign up for GitHub

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

Jump to bottom

Add markdown linting to CI #207

Closed
alice-i-cecile opened this issue Aug 11, 2021 · 1 comment
Closed

Add markdown linting to CI #207

alice-i-cecile opened this issue Aug 11, 2021 · 1 comment
Milestone
New Book Launch

Comments

@alice-i-cecile
Copy link
Member

This will help us ensure consistency and quality in the various content sections of the web site.

Some of the common options will likely need to be changed: in-line HTML is needed, and I'm not sure what the work-around for "code blocks must have a language" (used for displaying terminal output) should be.

As part of this change, we'll need a serious linting pass on old content so then we can keep CI green.
@alice-i-cecile alice-i-cecile mentioned this issue Jan 11, 2022
Open
14 tasks
@alice-i-cecile alice-i-cecile added this to the New Book Launch milestone Feb 9, 2022
@alice-i-cecile alice-i-cecile mentioned this issue Mar 10, 2022
Closed
5 tasks
bors bot pushed a commit that referenced this issue Mar 11, 2022
@alice-i-cecile
Enable mdlint in CI (#278)
73fad4a 
- Fixes #207 

# Status

- [x] Split the PR
- [x] Merge #272 (do first to reduce dumb merge conflicts).
- [x] Fix all mdlint violations
- [x] Update CI to target `master` rather than `main` (or fix the branch name per #140 )
- [x] Add local rules to ignore the same lints to improve contributor experience. I followed [these instructions](https://github.com/DavidAnson/vscode-markdownlint#configure); simply renaming the version in the .github folder didn't resolve the problem for me.
@alice-i-cecile
Copy link
Member Author

Fixed by #278.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
New Book Launch
Development

No branches or pull requests
1 participant
@alice-i-cecile