Skip to main content

Install Evidence

The easiest way to get started with Evidence is to use the VSCode Extension.

VSCode Extension

  1. Install Evidence from the VSCode Marketplace
  2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter Evidence: New Evidence Project
  3. Click Start Evidence in the bottom status bar
    • This will install required dependencies and start the Evidence server
    • You should see a browser window open automatically with your app preview
    • On Windows, this step can take a couple of minutes the first time
  4. Make changes to a markdown file and save the file to see the updates in your browser window

The template project running in your browser contains a tutorial on how to use Evidence.

Install VSCode Extension

If you run into any issues, reach out in Slack.

Other Options

npx degit evidence-dev/template my-project
cd my-project
npm install
npm run sources
npm run dev

System Requirements

See system requirements page.

Updating Evidence

See updating your project.