ml5-website-archive

This repo contains the legacy version of ml5.js website that is built with Gatsby and Netlify CMS. This website hosted at archive.ml5js.org.

Updating Instructions

markdown source files

• docs/index.md: home page content
• docs/community/: Experiments, currently feature image doesn't support gif and svg files
• docs/about.md: about page content

markdown templates

• community post markdown template

React pages

• src/pages: pages(routes) that serve as a collective page of a group of child pages, ex. reference collective page, community collective page, tag collective page
• src/templates: serve as the layout template for single markdown files

Assets

• docs/assets: markdown file assets, use relative path ../assets/ or ./assets/ to embed in markdown files.
• src/img: site assets, logos, social platform icons
• static/img(depracated): images that used in templates

Prerequisites

• Node
  • version: v10.19.0
  • Recommend using nvm
• Gatsby CLI

Access Locally

$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
$ cd [REPO_NAME]
$ nvm install // if you have nvm installed
$ npm i
$ npm run start

To test the CMS locally, you'll need run a production build of the site:

$ npm run build
$ npm run serve

Setting up the CMS

Follow the Netlify CMS Quick Start Guide to set up authentication, and hosting.

Running Netlify CMS

$ netlify dev # or ntl dev