Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added CONTRIBUTE.md #14

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions CONTRIBUTE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## 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).
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).