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.

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

ci: init markdown-lint and resolve linter issues #50

Merged
merged 1 commit into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions .github/workflows/lint-md.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Lint

on:
pull_request:
types: [opened, synchronize, reopened]
paths:
- "**.md"
push:
branches:
- main
paths:
- "**.md"

jobs:
lint-md:
name: Markdown
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
## detect errors from markdownlint-cli and create annotations for them
- uses: xt0rted/markdownlint-problem-matcher@v3
- uses: articulate/actions-markdownlint@v1
with:
config: .markdownlint.yaml
ignore: vendor
version: 0.39.0
21 changes: 21 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
# Default state for all rules
default: true

# MD013/line-length : Line length : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md013.md
MD013:
## Increase line length from default '80'
line_length: 250
## exluce code_blocks from line linter
code_blocks: false

# MD033/no-inline-html : Inline HTML : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md033.md
MD033:
allowed_elements:
- img
- div
- br
- a
- pre
- h1
- p
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<div align="center">
<div align="center"> <!-- markdownlint-disable-line first-line-heading -->
<img alt="World CLI Logo" src="https://i.imgur.com/XM74ODi.png" width="378">
<p>A swiss army knife for creating, managing, and deploying World Engine projects</p>
<p>
Expand Down Expand Up @@ -35,13 +35,15 @@ World CLI has been rigorously tested on macOS and Linux.
If you are using Windows, you will need
[WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) to install and use the CLI.

**Install latest release**
```
**Install latest release:**

```shell
curl https://install.world.dev/cli! | bash
```

**Install a specific release**
```
**Install a specific release:**

```shell
curl https://install.world.dev/cli@<release_tag>! | bash
```

Expand All @@ -53,17 +55,17 @@ This section is for devel developers who want to contribute to the World CLI.
If you want to develop a World Engine project using World CLI, see the
[World Engine quickstart guide](https://world.dev/quickstart)

**Building from source**
**Building from source:**

```
```shell
make build
```

**Testing your local build**
**Testing your local build:**

You can test your local build of World CLI by running the following command.
This will install the World CLI binary in your `/usr/local/bin` directory.

```
```shell
make install
```
```
Loading