Skip to content

Commit 6c402a9

Browse files
committed
docs: deno install
- https://deno.com/ - https://esm.sh/ Signed-off-by: Lexus Drumgold <[email protected]>
1 parent 295113a commit 6c402a9

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

.dictionary.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ cefc
33
codecov
44
commitlintrc
55
dedupe
6+
deno
67
dessant
78
docast
89
dohm

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,26 @@ If you want to handle syntax trees manually, use this. For an easier time proces
4949

5050
This package is [ESM only][esm].
5151

52+
In Node.js (version 18+) with [yarn][yarn]:
53+
5254
```sh
5355
yarn add @flex-development/docast-util-from-docs
5456
yarn add -D @flex-development/docast @types/mdast @types/unist micromark-util-types
5557
```
5658

57-
From Git:
58-
59-
```sh
60-
yarn add @flex-development/docast-util-from-docs@flex-development/docast-util-from-docs
61-
```
62-
6359
<blockquote>
6460
<small>
6561
See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
66-
&nbsp;for details on requesting a specific branch, commit, or tag.
62+
&nbsp;for details regarding installing from Git.
6763
</small>
6864
</blockquote>
6965

66+
In Deno with [`esm.sh`][esmsh]:
67+
68+
```ts
69+
import { fromDocs } from 'https://esm.sh/@flex-development/docast-util-from-docs'
70+
```
71+
7072
## Use
7173

7274
Say we have the following TypeScript file `fibonacci-sequence.ts`:
@@ -380,6 +382,7 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
380382
[docast]: https://github.com/flex-development/docast
381383
[docblock]: https://github.com/flex-development/docast#docblock-comment
382384
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
385+
[esmsh]: https://esm.sh/
383386
[mdast-code]: https://github.com/syntax-tree/mdast#code
384387
[mdast-util-extension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
385388
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
@@ -388,3 +391,4 @@ See [`CONTRIBUTING.md`](CONTRIBUTING.md).
388391
[typescript]: https://www.typescriptlang.org
389392
[unified]: https://github.com/unifiedjs/unified
390393
[vfile]: https://github.com/vfile/vfile#api
394+
[yarn]: https://yarnpkg.com

0 commit comments

Comments
 (0)