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
For more information about Frequency, visit [frequency.xyz](https://www.frequency.xyz)
9
-
or [Frequency on GitHub](https://github.com/LibertyDSNP/frequency)
9
+
or [Frequency on GitHub](https://github.com/frequency-chain/frequency)
10
10
11
11
## Install
12
12
13
13
To build the generator locally, install [mdBook](https://github.com/rust-lang/mdBook.git)
14
14
and [link checker](https://github.com/Michael-F-Bryan/mdbook-linkcheck). The link checker will run during build process and throw warnings for any broken internal
15
15
or external links.
16
16
17
-
```bash
17
+
```bash
18
18
cargo install mdbook
19
19
cargo install mdbook-linkcheck
20
20
npm install
21
21
```
22
+
22
23
## Run
23
24
24
25
### (Option 1) Active Build and Serve via HTTP
25
26
26
27
To run the doc generator locally, actively build after each change and serve them
27
28
via HTTP use the following command:
28
29
29
-
```bash
30
+
```bash
30
31
npm run serve
31
32
```
32
33
@@ -35,9 +36,10 @@ in the browser at <http://localhost:3000>. Note, it will not automatically refre
35
36
browser page after each change.
36
37
37
38
### (Option 2) Manual Build
39
+
38
40
To run the doc generator locally and preview the formatted docs from local files, use the following:
39
41
40
-
```bash
42
+
```bash
41
43
npm run build
42
44
```
43
45
@@ -53,4 +55,4 @@ The CI will automatically deploy what's merged into `main`.
53
55
54
56
## Tools and Frameworks
55
57
56
-
*[mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown
58
+
-[mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown
0 commit comments