Skip to content

Commit

Permalink
Add Diagrams section
Browse files Browse the repository at this point in the history
  • Loading branch information
erinkcochran87 committed Aug 23, 2024
1 parent e7be589 commit 181c017
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/docs-beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. Access the website at [http://localhost:3050](http://localhost:3050).

### Linters

To check the documentation for different issues, use the following:

```bash
Expand All @@ -71,6 +73,19 @@ yarn lint
yarn vale
```

### Diagrams

You can use [Mermaid.js](https://mermaid.js.org/syntax/flowchart.html) to create diagrams. For example:

```mermaid
flowchart LR
Start --> Stop
```

Refer to the [Mermaid.js documentation](https://mermaid.js.org/) for more info.

### Code examples

To include code snippets, use the following format:

```
Expand Down

0 comments on commit 181c017

Please sign in to comment.