Skip to content

Commit 2b5c2a1

Browse files
Also lint README.md using markdownlint (#13044)
1 parent cda4b94 commit 2b5c2a1

File tree

3 files changed

+15
-13
lines changed

3 files changed

+15
-13
lines changed

Diff for: .github/workflows/ci-markdown.yml

+1
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,4 @@ jobs:
3131
with:
3232
globs: |
3333
lib/elixir/pages/**/*.md
34+
README.md

Diff for: .markdownlint.jsonc

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
// Allowed HTML inline elements.
2323
"MD033": {
2424
"allowed_elements": [
25+
"h1",
2526
"a",
2627
"br",
2728
"img",

Diff for: README.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
<img src="https://github.com/elixir-lang/elixir-lang.github.com/raw/main/images/logo/logo.png#gh-light-mode-only" width="200" alt="Elixir">
2-
<img src="https://github.com/elixir-lang/elixir-lang.github.com/raw/main/images/logo/logo-dark.png#gh-dark-mode-only" width="200" alt="Elixir">
1+
<h1><img src="https://github.com/elixir-lang/elixir-lang.github.com/raw/main/images/logo/logo.png#gh-light-mode-only" width="200" alt="Elixir">
2+
<img src="https://github.com/elixir-lang/elixir-lang.github.com/raw/main/images/logo/logo-dark.png#gh-dark-mode-only" width="200" alt="Elixir"></h1>
33

44
[![CI](https://github.com/elixir-lang/elixir/workflows/CI/badge.svg?branch=main)](https://github.com/elixir-lang/elixir/actions?query=branch%3Amain+workflow%3ACI)
55

@@ -12,7 +12,7 @@ For more about Elixir, installation and documentation,
1212
## Policies
1313

1414
New releases are announced in the [announcement mailing list][8].
15-
You can subscribe by sending an email to [email protected]
15+
You can subscribe by sending an email to <[email protected]>
1616
and replying to the confirmation email.
1717

1818
All security releases [will be tagged with `[security]`][10]. For more
@@ -25,7 +25,7 @@ All interactions in our official communication channels follow our
2525

2626
For reporting bugs, [visit our issue tracker][2] and follow the steps
2727
for reporting a new issue. **Please disclose security vulnerabilities
28-
privately at [email protected]**.
28+
privately at <[email protected]>**.
2929

3030
## Issues tracker management
3131

@@ -107,17 +107,17 @@ We welcome everyone to contribute to Elixir. To do so, there are a few
107107
things you need to know about the code. First, Elixir code is divided
108108
in applications inside the `lib` folder:
109109

110-
* `elixir` - Elixir's kernel and standard library
110+
* `elixir` - Elixir's kernel and standard library
111111

112-
* `eex` - EEx is the template engine that allows you to embed Elixir
112+
* `eex` - EEx is the template engine that allows you to embed Elixir
113113

114-
* `ex_unit` - ExUnit is a simple test framework that ships with Elixir
114+
* `ex_unit` - ExUnit is a simple test framework that ships with Elixir
115115

116-
* `iex` - IEx stands for Interactive Elixir: Elixir's interactive shell
116+
* `iex` - IEx stands for Interactive Elixir: Elixir's interactive shell
117117

118-
* `logger` - Logger is the built-in logger
118+
* `logger` - Logger is the built-in logger
119119

120-
* `mix` - Mix is Elixir's build tool
120+
* `mix` - Mix is Elixir's build tool
121121

122122
You can run all tests in the root directory with `make test` and you can
123123
also run tests for a specific framework `make test_#{APPLICATION}`, for example,
@@ -166,9 +166,9 @@ With tests running and passing, you are ready to contribute to Elixir and
166166
We have saved some excellent pull requests we have received in the past in
167167
case you are looking for some examples:
168168
169-
* [Implement Enum.member? - Pull request](https://github.com/elixir-lang/elixir/pull/992)
170-
* [Add String.valid? - Pull request](https://github.com/elixir-lang/elixir/pull/1058)
171-
* [Implement capture_io for ExUnit - Pull request](https://github.com/elixir-lang/elixir/pull/1059)
169+
* [Implement Enum.member? - Pull request](https://github.com/elixir-lang/elixir/pull/992)
170+
* [Add String.valid? - Pull request](https://github.com/elixir-lang/elixir/pull/1058)
171+
* [Implement capture_io for ExUnit - Pull request](https://github.com/elixir-lang/elixir/pull/1059)
172172
173173
### Reviewing changes
174174

0 commit comments

Comments
 (0)