Skip to content

Commit

Permalink
Add generic linters (#2)
Browse files Browse the repository at this point in the history
* Add generic linters

* Fix lint
  • Loading branch information
dmohns authored Feb 29, 2024
1 parent 00ba25f commit b076ae7
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 3 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/check-generic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Generic checks to ease collaboration:
# - consistent file encoding in UNIX style
# - whitespaces in all purposes files like markdown, yaml, etc
name: Check Generic

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
editorconfig-checker:
name: Run editorconfig-checker
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run editorconfig-checker
run: docker run --rm --volume=$PWD:/check mstruebing/editorconfig-checker

markdownlint:
name: Run markdownlint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run markdownlint-cli2
uses: DavidAnson/markdownlint-cli2-action@v13

yamllint:
name: Run yamllint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run yamllint
run: yamllint .
4 changes: 1 addition & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,6 @@ sidebar_position: 0

---

# Tutorial Intro

Let's discover **Docusaurus in less than 5 minutes**.

## Getting Started
Expand Down Expand Up @@ -75,6 +73,6 @@ npm run start

The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.

The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at <http://localhost:3000/>.

Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.

0 comments on commit b076ae7

Please sign in to comment.