Skip to content

Commit

Permalink
docs: fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
olizilla authored Nov 14, 2023
1 parent da99de1 commit 1c3ea68
Showing 1 changed file with 4 additions and 14 deletions.
18 changes: 4 additions & 14 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This repository contains the specs for the `w3up` protocol and associated subsystems.

The implementations of these specs can be found in https://github.com/web3-storage/w3up
The implementations of these specs can be found in <https://github.com/web3-storage/w3up>

## Getting started

Expand Down Expand Up @@ -30,27 +30,17 @@ Nothing in this spec repository is `permanent` or even `stable` yet. Most of the

## Contribute

[![contribute](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

Suggestions, contributions, criticisms are welcome. Though please make sure to familiarize yourself deeply with IPFS, the models it adopts, and the principles it follows.
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

### Linting

The CI runs [markdownlint](https://github.com/DavidAnson/markdownlint) via [markdownlint-cli2-action](https://github.com/marketplace/actions/markdownlint-cli2-action) with the rules in [.markdownlint.jsonc](.markdownlint.jsonc).

To run the linter locally you can use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) with `npx markdownlint-cli2 '*.md'` or install [vscode-markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) in vscode.
The CI runs [markdownlint](https://github.com/DavidAnson/markdownlint) via [markdownlint-cli2-action](https://github.com/marketplace/actions/markdownlint-cli2-action) with the rules in [.markdownlint.jsonc](.markdownlint.jsonc). To run the linter locally you can use [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) with `npx markdownlint-cli2 '*.md'` or install [vscode-markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) in vscode.

Optionally [prettier-vscode](https://github.com/prettier/prettier-vscode) can also be use to format code blocks inside markdown files.

### Spellcheck

The CI runs a spellcheck using [md-spellcheck-action](https://github.com/matheus23/md-spellcheck-action).

If you want to use a word that's being flagged by the spellchecker, add it to [.github/workflows/words-to-ignore.txt](./.github/workflows/words-to-ignore.txt).

Since the spellchecker depends on GitHub Actions, the best way to run it locally is with [act](https://github.com/nektos/act), a Docker-based GitHub Actions workflow runner.

When you first run `act`, it will ask what base image to use as a default. The actions in this repo run fine with the default "medium" base image.
The CI runs a spellcheck using [md-spellcheck-action](https://github.com/matheus23/md-spellcheck-action). If you want to use a word that's being flagged by the spellchecker, add it to [.github/workflows/words-to-ignore.txt](./.github/workflows/words-to-ignore.txt).

Once `act` is installed, you can run the full CI suite with `act pull_request`. This will also run the markdown linting action described above.
Since the spellchecker depends on GitHub Actions, the best way to run it locally is with [act](https://github.com/nektos/act), a Docker-based GitHub Actions workflow runner. When you first run `act`, it will ask what base image to use as a default. The actions in this repo run fine with the default "medium" base image. Once `act` is installed, you can run the full CI suite with `act pull_request`. This will also run the markdown linting action described above.

0 comments on commit 1c3ea68

Please sign in to comment.