File tree 2 files changed +14
-7
lines changed
2 files changed +14
-7
lines changed Original file line number Diff line number Diff line change 1
1
# ` deno_doc `
2
2
3
+ [ ![ ] ( https://img.shields.io/crates/v/deno_doc.svg )] ( https://crates.io/crates/deno_doc )
4
+ [ ![ JSR] ( https://jsr.io/badges/@deno/doc )] ( https://jsr.io/@deno/doc )
5
+
3
6
A Rust crate to generate documentation for JavaScript and TypeScript modules.
4
7
5
8
This crate powers
Original file line number Diff line number Diff line change 1
1
# ` deno_doc `
2
2
3
3
This repository includes a compiled version of the Rust crate as Web Assembly
4
- and exposes an interface which is available via the ` mod.ts ` and can be imported
5
- like this:
4
+ and exposes an interface which is available via the ` mod.ts ` .
6
5
7
- ``` ts
8
- import { doc } from " jsr:@deno/doc@{VERSION}" ;
6
+ Install:
7
+
8
+ ``` sh
9
+ deno add jsr:@deno/doc
9
10
```
10
11
11
- Where ` {VERSION} ` should be substituted with the specific version you want to
12
- use.
12
+ Use:
13
+
14
+ ``` ts
15
+ import { doc } from " @deno/doc" ;
16
+ ```
13
17
14
18
## ` doc() `
15
19
@@ -21,7 +25,7 @@ A minimal example of using `doc()` and printing out some information about a
21
25
function:
22
26
23
27
``` ts
24
- import { doc } from " jsr: @deno/doc@{VERSION} " ;
28
+ import { doc } from " @deno/doc" ;
25
29
26
30
const colorsDoc = await doc (" https://deno.land/std/fmt/colors.ts" );
27
31
You can’t perform that action at this time.
0 commit comments