Uses Gatsby for rendering a static site that is built and deployed with Netlify.

Gatsby requires Node.js, and we recommend using yarn for installing packages.

Click here to develop the handbook locally

In a terminal, change into the website directory, and run:

yarn install

Then to serve the site, you have two options:

1. To serve the static (built) version of the website (good for final review):

yarn serve

2. To serve the site using the development server with auto-compiling and page reloading:

yarn start

We want and encourage everyone at Sourcegraph to contribute to the blog and publishing a blog post is as simple as merging an approved pull request with your blog content.

Learn how to create and publish a blog post.

The Sourcegraph handbook also lives in this repository. Soon it will be deployed together with the rest of the about.sourcegraph.com site.

The handbook uses docsite.

• To preview changes to handbook content locally, run make serve, and open http://localhost:5082.
• To check for broken links and other lint problems, run make docsite-check.
• See detailed docsite instructions.