From efa4821d640ebf381c10b8214331e8370ab0e893 Mon Sep 17 00:00:00 2001 From: "Mark S. Miller" Date: Sat, 30 Sep 2023 18:29:56 -0700 Subject: [PATCH] docs: identify language in some markdown blocks --- CONTRIBUTING.md | 2 +- packages/eslint-plugin/README.md | 13 ++++--------- packages/marshal/README.md | 4 ++-- packages/ses/package.json.md | 2 +- 4 files changed, 8 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c26d6c14b..3b8aba6f03 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Initial setup -``` +```sh git clone git@github.com:endojs/endo.git cd endo yarn diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index bc4b5a1ef4..83e2758338 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -6,14 +6,14 @@ Endo-specific plugin You'll first need to install [ESLint](http://eslint.org): -``` -$ npm i eslint --save-dev +```sh +npm i eslint --save-dev ``` Next, install `@endo/eslint-plugin`: -``` -$ npm install @endo/eslint-plugin --save-dev +```sh +npm install @endo/eslint-plugin --save-dev ``` **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `@endo/eslint-plugin` globally. @@ -52,8 +52,3 @@ You can configure individual rules you want to use under the rules section. ## Supported Rules * Fill in provided rules here - - - - - diff --git a/packages/marshal/README.md b/packages/marshal/README.md index 760ab22ef3..92953f5c9b 100644 --- a/packages/marshal/README.md +++ b/packages/marshal/README.md @@ -54,7 +54,7 @@ be expressed directly in JSON. These special values are usually strings with reserved prefixes in the preferred "smallcaps" encoding, but in the original encoding were objects with a property named `@qclass`. For example: -``` +```js import '@endo/init'; import { makeMarshal } from '@endo/marshal'; @@ -104,7 +104,7 @@ will be used as the slot identifier to be placed into the slots array, and the serialized `body`, in place of the object, will contain a special value referencing that slot identifier by its index in the slots array. For example: -``` +```js import '@endo/init'; import { makeMarshal } from '@endo/marshal'; diff --git a/packages/ses/package.json.md b/packages/ses/package.json.md index 26bb1a0d0e..15519a5409 100644 --- a/packages/ses/package.json.md +++ b/packages/ses/package.json.md @@ -69,7 +69,7 @@ A pragma can be used in any JavaScript file to import the global type definitions from SES into environments that assume SES has been initialized and do not directly import the shim. -``` +```js /// ```