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

Markdown Linter #581

Merged
merged 9 commits into from
Dec 18, 2020
Merged

Markdown Linter #581

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d01ecec
add linter
aokellermann Dec 17, 2020
ab0b6ce
Lint
aokellermann Dec 18, 2020
a8670f1
Mention markdownlint in contributing
aokellermann Dec 18, 2020
25b8e29
Merge branch 'master' into MarkdownLinter
aokellermann Dec 18, 2020
a4b2453
Address review
aokellermann Dec 18, 2020
fd21a04
line length
aokellermann Dec 18, 2020
310c44c
split lines
aokellermann Dec 18, 2020
87a1925
Don't lint headers
aokellermann Dec 18, 2020
8fa62ff
Remove comment
aokellermann Dec 18, 2020
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
Prev Previous commit
Next Next commit
Mention markdownlint in contributing
  • Loading branch information
@aokellermann
aokellermann committed Dec 18, 2020
commit a8670f1c311525da4f3dfb3fe6893bbc1453a815
6 changes: 4 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -425,7 +425,7 @@ All four scripts use functionality defined in the [DevUtils](/DevUtils) package.

Note that the `pack.wls` script will auto-generate the paclet version number based on the number of commits to master from the checkpoint defined in [version.wl](/scripts/version.wl).

## Code style
## Style

### Wolfram Language

Expand Down Expand Up @@ -558,10 +558,12 @@ comments section.
If you want to disable formatting, use `// clang-format off` and `// clang-format on` around the manually formatted
code.

#### Markdown
### Markdown

We are using GitHub-flavored Markdown for documentation and research notes.

We use [`markdownlint`](https://github.com/DavidAnson/markdownlint) for formatting and linting markdown text.

#### Manual image embedding

Images (e.g., of output cells) can be made by selecting the relevant cells in the Front End, copying them as bitmaps, and saving them as .png files to [Documentation/Images](/Documentation/Images) (in the documentation) or to the Images directory of the corresponding research note. They should then be inserted using the code similar to this:
Expand Down