Skip to main content

Install Evidence

If this is your first time doing something like this, or you just need a reminder, check out the Detailed Installation Walkthrough.

System Requirements#

Evidence requires NPM Version 7 or higher.

Check which version you have with npm -v

Install the latest version with npm install -g npm@latest

Alternatively using Docker instead of NPM#

Typically, Evidence requires npm to be installed. However, if you are familiar with Docker, and wish not to work with npm, Evidence provides a development Docker image. Take a look at our Docker Development Environment repository for more details if you wish to go down this path.

Install & Launch#

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

Open your browser and go to localhost:3000

VS Code Extension (Optional)#

If you use VS Code, the Evidence VS Code Extension adds handy syntax highlighting and basic autocomplete for 'Evidence flavoured' markdown. You can install the extension from the the VS Code marketplace.