You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
2. First, run `just i` to install the dependencies.
51
+
3. Then, run `just dev` to start the development server and
52
52
4. Visit [localhost:3000](http://localhost:3000) in your browser to view the website.
53
53
54
54
You can now start changing content and see the website updated live each time you save a new file. 🤓
@@ -57,13 +57,13 @@ You can now start changing content and see the website updated live each time yo
57
57
58
58
**Important prerequisite**
59
59
60
-
To prevent building issues upstream, you should build the content locally before submitting a pull request: stop or delete the terminal server if it's running, then run `pnpm dev`.
60
+
To prevent building issues upstream, you should build the content locally before submitting a pull request: stop or delete the terminal server if it's running, then run `just dev`.
61
61
62
62
- Use the information reported by the terminal to fix any issues (e.g., broken links).
63
-
- Run `pnpm fix` to automatically fix most linting issues (e.g., formatting and style guide).
64
-
- Run `pnpm spellcheck:lint` to test your content against the dictionary. Add new words to the dictionary by appending them to `words.txt`.
65
-
- Run `pnpm spellcheck:fix` to add new words to the dictionary automatically.
66
-
- Try another `pnpm dev` and repeat until no issues are reported ("client" and "server compiled successfully").
63
+
- Run `just fix` to automatically fix most linting issues (e.g., formatting and style guide).
64
+
- Run `just spellcheck:lint` to test your content against the dictionary. Add new words to the dictionary by appending them to `words.txt`.
65
+
- Run `just spellcheck:fix` to add new words to the dictionary automatically.
66
+
- Try another `just dev` and repeat until no issues are reported ("client" and "server compiled successfully").
67
67
68
68
69
69
Your pull request should usually target the `main` branch, though the Optimism Documentation team might sometimes ask you to target another branch.
Copy file name to clipboardExpand all lines: notes/remark.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Remark is a flexible Markdown processor with a [vibrant plugin ecosystem](https:
8
8
9
9
### Adding Rules
10
10
11
-
To add a linting rule, simply install your desired linting rule via `pnpm` and add the rule to the [`.remarkrc.mjs`](/.remarkrc.mjs) configuration file at the root of this repository.
11
+
To add a linting rule, simply install your desired linting rule via `just` and add the rule to the [`.remarkrc.mjs`](/.remarkrc.mjs) configuration file at the root of this repository.
12
12
You can find a list of rules maintained by the Remark team on the [`remark-lint`](https://github.com/remarkjs/remark-lint#rules) repository.
13
13
If you need to write your own custom plugin, place the plugin inside of [`utils/plugins/remark`](/utils/plugins/remark/)
0 commit comments