Skip to content
This repository was archived by the owner on Aug 8, 2023. It is now read-only.

Commit e366981

Browse files
author
Jeremy Wiebe
committed
Fix linting issues in docs/README.md
1 parent da57b00 commit e366981

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

docs/README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ docs.mobify.com.
99

1010
To make writing document easier, we provide:
1111

12-
* A linter for consistent markdown style.
13-
* A writing checklist for consistent process.
12+
- A linter for consistent markdown style.
13+
- A writing checklist for consistent process.
1414

1515
### Markdown Linting
1616

@@ -32,22 +32,24 @@ npm install --save-dev mobify-code-style
3232
**Before you start writing**
3333

3434
Write down the goal of your document.
35-
* Does a similar document exist? Could it be extended to meet the goal?
36-
* Does your document fit in an existing category? If so, which one?
35+
36+
- Does a similar document exist? Could it be extended to meet the goal?
37+
- Does your document fit in an existing category? If so, which one?
3738

3839
Who is your audience? What is their skill level?
3940

4041
What kind of document best meets your goal?
41-
* [Step-by-step tutorials](https://jacobian.org/writing/what-to-write/#tutorials)
42-
* [Overview or topical guide to a conceptual area](https://jacobian.org/writing/what-to-write/#topical-guides)
43-
* [Low-level, deep-dive reference material](https://jacobian.org/writing/what-to-write/#reference)
42+
43+
- [Step-by-step tutorials](https://jacobian.org/writing/what-to-write/#tutorials)
44+
- [Overview or topical guide to a conceptual area](https://jacobian.org/writing/what-to-write/#topical-guides)
45+
- [Low-level, deep-dive reference material](https://jacobian.org/writing/what-to-write/#reference)
4446

4547
**While writing**
4648

47-
* [Write like you talk](http://paulgraham.com/talk.html).
48-
* [Only use terms from the glossary](https://docs.google.com/document/d/1xbHkio-hdps-5zZG-SmmAKbR9WpXtrJJ-fprShN7NkM/edit).
49+
- [Write like you talk](http://paulgraham.com/talk.html).
50+
- [Only use terms from the glossary](https://docs.google.com/document/d/1xbHkio-hdps-5zZG-SmmAKbR9WpXtrJJ-fprShN7NkM/edit).
4951

5052
**After writing**
5153

52-
* [ ] 👍 Review
53-
* [ ] 🍻 Celeberate
54+
- [ ] 👍 Review
55+
- [ ] 🍻 Celeberate

0 commit comments

Comments
 (0)