Skip to content

Latest commit

 

History

History
28 lines (16 loc) · 1.24 KB

README.md

File metadata and controls

28 lines (16 loc) · 1.24 KB

The Vitess website

This repo houses the assets used to build the website at https://vitess.io.

Running the site locally

To run the website locally, you need to have the Hugo static site generator installed (installation instructions here). Installing the Hugo version in netlify.toml is recommended.

Once Hugo is installed run the following:

hugo server --buildDrafts --buildFuture

This starts Hugo in local mode. You can see access the site at http://localhost:1313.

You will also need to either:

  • install npm and run npm install or,
  • install and run yarn

Adding a user logo

If you'd like to add your logo to the Who uses Vitess section of the website, add a PNG, JPEG, or SVG of your logo to the static/img/logos/users directory in this repo and submit a pull request with your change. Name the image file something that reflects your company (e.g., if your company is called Acme, name the image acme.png).

Link checking

You can check the site's internal links by running make check-internal-links and all links—internal and external—by running make check-all-links.