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.

Sign up for GitHub

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

Jump to bottom

Update README.md #1060

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+0 −27
Open

Update README.md #1060

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 0 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +0,0 @@
<img src="https://github.com/MinaProtocol/docs/blob/main/public/static/img/svg/mina-wordmark-redviolet.svg" width="350" alt="Mina logo">

# Mina Docs

## To view the docs

To view this website, visit [docs.minaprotocol.com](https://docs.minaprotocol.com/).

## To contribute content

Click the `Suggest changes` button at the bottom left of any page on [the docs website](https://docs.minaprotocol.com/) to edit that page and submit a pull request via Github.

## How to run during development

```sh
git clone https://github.com/o1-labs/docs2.git
npm install
npm run dev
```

## How to run in production

On the host:
- Set environment variables: `ALGOLIA_APP_ID` and `ALGOLIA_SEARCH_API_KEY` to appropriate values.
- Set build command: `npm run build`.
- Set output directory: `build`.
- Set install command: `npm ci`.