Skip to content

Commit

Permalink
Update repository locations
Browse files Browse the repository at this point in the history
  • Loading branch information
wilwade committed May 3, 2024
1 parent b3b6ccd commit 12e22bb
Show file tree
Hide file tree
Showing 5 changed files with 168 additions and 15 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,31 @@
Technical documentation for the Frequency parachain.
The current documentation can be viewed in its compiled form at https://docs.frequency.xyz.
Alternatively, the latest iteration of the docs [can be viewed
non-formatted here](https://github.com/LibertyDSNP/frequency-docs/tree/main/pages).
non-formatted here](https://github.com/frequency-chain/docs/tree/main/pages).

For more information about Frequency, visit [frequency.xyz](https://www.frequency.xyz)
or [Frequency on GitHub](https://github.com/LibertyDSNP/frequency)
or [Frequency on GitHub](https://github.com/frequency-chain/frequency)

## Install

To build the generator locally, install [mdBook](https://github.com/rust-lang/mdBook.git)
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
or external links.

``` bash
```bash
cargo install mdbook
cargo install mdbook-linkcheck
npm install
```

## Run

### (Option 1) Active Build and Serve via HTTP

To run the doc generator locally, actively build after each change and serve them
via HTTP use the following command:

``` bash
```bash
npm run serve
```

Expand All @@ -35,9 +36,10 @@ in the browser at <http://localhost:3000>. Note, it will not automatically refre
browser page after each change.

### (Option 2) Manual Build

To run the doc generator locally and preview the formatted docs from local files, use the following:

``` bash
```bash
npm run build
```

Expand All @@ -53,4 +55,4 @@ The CI will automatically deploy what's merged into `main`.

## Tools and Frameworks

* [mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown
- [mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown
Loading

0 comments on commit 12e22bb

Please sign in to comment.