Skip to content

Commit

Permalink
docs: deno install
Browse files Browse the repository at this point in the history
- https://deno.com/
- https://esm.sh/

Signed-off-by: Lexus Drumgold <[email protected]>
  • Loading branch information
unicornware committed Feb 20, 2024
1 parent 295113a commit 6c402a9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 7 deletions.
1 change: 1 addition & 0 deletions .dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ cefc
codecov
commitlintrc
dedupe
deno
dessant
docast
dohm
Expand Down
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,26 @@ If you want to handle syntax trees manually, use this. For an easier time proces

This package is [ESM only][esm].

In Node.js (version 18+) with [yarn][yarn]:

```sh
yarn add @flex-development/docast-util-from-docs
yarn add -D @flex-development/docast @types/mdast @types/unist micromark-util-types
```

From Git:

```sh
yarn add @flex-development/docast-util-from-docs@flex-development/docast-util-from-docs
```

<blockquote>
<small>
See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
&nbsp;for details on requesting a specific branch, commit, or tag.
&nbsp;for details regarding installing from Git.
</small>
</blockquote>

In Deno with [`esm.sh`][esmsh]:

```ts
import { fromDocs } from 'https://esm.sh/@flex-development/docast-util-from-docs'
```

## Use

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

0 comments on commit 6c402a9

Please sign in to comment.