This repo contains the source files of the Diffbot documentation suite currently deployed at https://diffbot.github.io/docs
To contribute, either submit a pull request with an edit on this repository by adding or editing files in the
docs folder, or click the
Edit button on any page in the rendered website.
To add a new page:
- Add the page into the
- Add the page's ID into
sidebars.jsonto reference it in the menus.
Note that if you want to add contributions that touch on design, images, landing page text or other non-documentation content, you need to edit the files in the
To build and test the docs locally:
- Make sure you have yarn installed (yarnpkg.com)
- Clone this repo
cd docs/diffbot; yarn install
This will open a browser with the local version running in live-reload mode, so you can see your changes as you save your files. Note that menus will not update with this approach, so you need to kill the server with
CTRL+C and restart with
yarn start to test menu changes.