Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

How to add an example

• Create an mdx file in docs/examples/. Easier to copy an existing one for format:
  • Summarize the example emphasizing Interval's value in a paragraph at the top
  • Take a nice screenshot/gif for below the summary
  • If the example is from a more comprehensive blog post or guide, link to it via an :::info block
  • Provide code examples to highlight and explain how to code up the core functionality bits for the example
  • Link to any API methods used at the bottom
• Update sidebars.js to include a link to the newe page
• Update web/src/utils/examples.js to allow selecting the example during onboarding
• Use create-interval-app to build a repo that implements your example, and commit it to our interval-examples repo using the appropriate slug that defines the example
  • Will need one for javascript and one for typescript
  • Be sure to remove auto-generated .git directories before commiting examples