Skip to content

Commit

Permalink
Updated Readme with section How to contribute (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
vr-varad authored Feb 8, 2024
1 parent 73b93cd commit 5a391f9
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,36 @@ For more information about other install methodologies and platforms or Docker,
## Examples

You can find a complete [list of examples in the documentation](/docs/docs.md#_43-examples). If you are interested in submitting new examples, please [contact us in our chats](/docs/community.md#community).

## How to Contribute

### Starting Stack

- Clone the repository:

```bash
git clone https://github.com/metacall/landing-page.git
cd landing-page
```

### How to Run

1. Install `docsify-cli` globally:

```bash
npm install docsify-cli -g
```

2. Initialize docsify in the "./docs" directory:

```bash
docsify init ./docs
```

3. Run the local server with docsify:

```bash
docsify serve docs
```

You can now preview your site in your browser by navigating to [http://localhost:3000](http://localhost:3000).

0 comments on commit 5a391f9

Please sign in to comment.