Skip to content

Latest commit

 

History

History
36 lines (23 loc) · 1.56 KB

README.md

File metadata and controls

36 lines (23 loc) · 1.56 KB
Raw

Inclusive Naming Initiative

This repository is a Hugo website for the Inclusive Naming Initiative.

Using this repository

This repository uses:

  • Hugo as a static site generator. Hugo is Golang-based, so you'll need that as well.
  • Bootstrap 4.5.x as a CSS framework
  • Netlify for building, hosting, and DNS management

Running locally

Make sure you have npm and yarn installed. Clone this repository and run the following two commands in its directory:

# Install npm assets
yarn

# Run the server locally
make serve

Running on Netlify

Netlify is a CI/CD build tool and hosting solution for (among other things) static sites. We strongly recommend using Netlify unless you have a good reason not to.

This repository comes with a pre-configured netlify.toml file. To build to Netlify:

  1. Go to netlify.com and sign up. We recommend signing up using a GitHub account.

  2. Click New Site from Git, and give Netlify access to your GitHub account.

    Note: For projects with lots of contributors, it can be handy to create a general/bot account instead of granting access with a personal account.

  3. Install Netlify with access to your documentation site repository.

  4. Leave all other settings as default and click Deploy Site.