Skip to content

Commit 0a02c13

Browse files
AlexJSullyAlexJSully
authored
Add support for Markdown linting (#61)
As this repository and application depends on converting Markdown files into webpages, add markdown linting support.
1 parent 8b23a84 commit 0a02c13

File tree

19 files changed

+2232
-118
lines changed

19 files changed

+2232
-118
lines changed

.github/workflows/code-qa.yml renamed to .github/workflows/code-qa.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
22
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
33

4-
name: Code Qualtiy Assurance
4+
name: Code Quality Assurance
55

66
on:
77
push:
@@ -19,18 +19,18 @@ jobs:
1919

2020
strategy:
2121
matrix:
22-
node-version: [18.x]
22+
node-version: [22.x]
2323
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
2424

2525
steps:
2626
- name: Checkout repository
2727
uses: actions/checkout@v4
2828
- name: Use Node.js ${{ matrix.node-version }}
29-
uses: actions/setup-node@v2
29+
uses: actions/setup-node@v4
3030
with:
3131
node-version: ${{ matrix.node-version }}
3232
- name: Cache Node.js modules
33-
uses: actions/cache@v3
33+
uses: actions/cache@v4
3434
with:
3535
path: ~/.npm
3636
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}

.github/workflows/codeql-analysis.yml renamed to .github/workflows/codeql-analysis.yaml

File renamed without changes.

‎.github/workflows/markdown-lint.yaml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Markdown Lint
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- "**/*.md"
8+
- ".markdownlint.json"
9+
- ".markdownlintignore"
10+
- ".github/workflows/markdown-lint.yaml"
11+
pull_request:
12+
branches: [master]
13+
paths:
14+
- "**/*.md"
15+
- ".markdownlint.json"
16+
- ".markdownlintignore"
17+
- ".github/workflows/markdown-lint.yaml"
18+
19+
jobs:
20+
lint-markdown:
21+
runs-on: ubuntu-latest
22+
23+
steps:
24+
- name: Checkout repository
25+
uses: actions/checkout@v4
26+
- name: Use Node.js ${{ matrix.node-version }}
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: ${{ matrix.node-version }}
30+
- name: Cache Node.js modules
31+
uses: actions/cache@v4
32+
with:
33+
path: ~/.npm
34+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
35+
restore-keys: |
36+
${{ runner.os }}-node-
37+
- name: Run installs
38+
run: npm ci
39+
- name: Run markdownlint on Markdown files
40+
run: npm run lint:markdown

‎.github/workflows/ossar-analysis.yml‎

Lines changed: 0 additions & 52 deletions
This file was deleted.

‎.markdownlint.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"MD010": false,
3+
"MD013": false,
4+
"MD029": false,
5+
"MD036": false,
6+
"MD041": false,
7+
"MD059": false
8+
}

‎.markdownlintignore‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# dependencies
2+
**/node_modules
3+
/.pnp
4+
.pnp.js
5+
6+
# Build files
7+
*.min.js
8+
*.min.css
9+
sw.js
10+
*.js.map
11+
12+
# Packages
13+
src/scripts/libraries
14+
15+
# misc
16+
.DS_Store
17+
.env.local
18+
.env.development.local
19+
.env.test.local
20+
.env.production.local
21+
.vscode
22+
23+
# workbox
24+
workbox-config.js
25+
src/serviceWorker
26+
27+
# Visual Studio Code
28+
.vscode/settings.json
29+
.vscode/launch.json
30+
31+
# Ignore minified files
32+
*.min.*

‎.prettierrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"arrowParens": "always",
33
"bracketSpacing": true,
44
"endOfLine": "auto",
5+
"jsxSingleQuote": true,
56
"printWidth": 120,
67
"semi": true,
78
"tabWidth": 4,

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,10 +173,10 @@ Bug fix:
173173

174174
All articles posted onto Small Dev Talk have now been fully archived including all uploaded videos by Small Dev Talk. Read the README for more instructions and updates.
175175

176-
Visit https://asully.github.io/Small-Dev-Talk/ to view Small Dev Talk's articles
176+
Visit <https://asully.github.io/Small-Dev-Talk/> to view Small Dev Talk's articles
177177

178178
## [1.0.0] - 2018-08-23
179179

180-
This is the release of the code that was used in the Small Dev Talk's website between March 2013 and April 2016. You can visit the website for Small Dev Talk at http://smalldevtalk.net (or http://smalldevtalk.tumblr.com if that link no longer works).
180+
This is the release of the code that was used in the Small Dev Talk's website between March 2013 and April 2016. You can visit the website for Small Dev Talk at <http://smalldevtalk.net> (or <http://smalldevtalk.tumblr.com> if that link no longer works).
181181

182182
We wish the best of luck to all those were involved in Small Dev Talk (Alexander Sullivan, Neil Rampone and Jeff Cen) and all those we had the pleasure of talking with during Small Dev Talk's active period. And most importantly, thank you to all of our readers who visited Small Dev Talk!

‎CODE_OF_CONDUCT.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -115,13 +115,13 @@ the community.
115115

116116
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117117
version 2.0, available at
118-
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
118+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
119119

120120
Community Impact Guidelines were inspired by [Mozilla's code of conduct
121121
enforcement ladder](https://github.com/mozilla/diversity).
122122

123123
[homepage]: https://www.contributor-covenant.org
124124

125125
For answers to common questions about this code of conduct, see the FAQ at
126-
https://www.contributor-covenant.org/faq. Translations are available at
127-
https://www.contributor-covenant.org/translations.
126+
<https://www.contributor-covenant.org/faq>. Translations are available at
127+
<https://www.contributor-covenant.org/translations>.

‎LICENSE.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
GNU GENERAL PUBLIC LICENSE
2-
Version 3, 29 June 2007
1+
GNU GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
33

4-
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
4+
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
55
Everyone is permitted to copy and distribute verbatim copies
66
of this license document, but changing it is not allowed.
77

@@ -645,7 +645,7 @@ the "copyright" line and a pointer to where the full notice is found.
645645
GNU General Public License for more details.
646646

647647
You should have received a copy of the GNU General Public License
648-
along with this program. If not, see <http://www.gnu.org/licenses/>.
648+
along with this program. If not, see <https://www.gnu.org/licenses/>.
649649

650650
Also add information on how to contact you by electronic and paper mail.
651651

@@ -657,18 +657,18 @@ notice like this when it starts in an interactive mode:
657657
This is free software, and you are welcome to redistribute it
658658
under certain conditions; type `show c' for details.
659659

660-
The hypothetical commands `show w' and `show c' should show the appropriate
660+
The hypothetical commands `show w' and`show c' should show the appropriate
661661
parts of the General Public License. Of course, your program's commands
662662
might be different; for a GUI interface, you would use an "about box".
663663

664664
You should also get your employer (if you work as a programmer) or school,
665665
if any, to sign a "copyright disclaimer" for the program, if necessary.
666666
For more information on this, and how to apply and follow the GNU GPL, see
667-
<http://www.gnu.org/licenses/>.
667+
<https://www.gnu.org/licenses/>.
668668

669669
The GNU General Public License does not permit incorporating your program
670670
into proprietary programs. If your program is a subroutine library, you
671671
may consider it more useful to permit linking proprietary applications with
672672
the library. If this is what you want to do, use the GNU Lesser General
673673
Public License instead of this License. But first, please read
674-
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
674+
<https://www.gnu.org/licenses/why-not-lgpl.html>.

0 commit comments

Comments
 (0)