everydotorg / charity-api-docs

Documentation for the Every.org Charity API.

Home Page:every-org.vercel.app

Repository from Github https://github.comeverydotorg/charity-api-docsRepository from Github https://github.comeverydotorg/charity-api-docs

Website

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

You can view the latest version of Every.org's Charity API documentation at docs.every.org.

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.

About

Documentation for the Every.org Charity API.

every-org.vercel.app


Languages

Language:JavaScript 75.6%Language:CSS 21.7%Language:TypeScript 2.7%