Skip to content

Latest commit

 

History

History
51 lines (35 loc) · 1.34 KB

README.md

File metadata and controls

51 lines (35 loc) · 1.34 KB

CardinalKit Logo CardinalKit Logo

Documentation

This repository contains the documentation website for CardinalKit, of which a live version can be found at https://cardinalkit.org/cardinalkit-docs/.

Instructions

Setting up this project requires Node.js installed on your system.

First, open the src folder and install dependencies

cd src
npm install

To configure Algolia search, edit the included .env file and add in the listed keys.

To run in development mode

npm run dev

The site should now appear at http://localhost:8080/cardinalkit-docs.

To build for production

npm run build

To deploy to GitHub pages

From the root folder of the project, run

On Mac or Linux:

./deploy.sh

On Windows:

.\deploy.bat

Built With

VuePress

Stanford Byers Center for Biodesign Logo Stanford Byers Center for Biodesign Logo