SourceBots Kit Documentation
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
content Update enum values to match API Aug 8, 2018
layouts
scripts Remove scripts Mar 17, 2018
static Update rules to Smallpeice 2018 Aug 5, 2018
themes Stop teams maybe blowing up motor boards Aug 6, 2018
.gitignore Change URL Oct 28, 2017
.gitmodules Install theme Oct 10, 2017
.spelling
README.md Bump Hugo version to 0.40 Jun 5, 2018
config.yml Add Github Edit Links Mar 6, 2018
netlify.toml
package-lock.json Add package lock file stolen from circleci Feb 20, 2018
package.json
shell.nix Revoke update to shell.nix Jun 11, 2018

README.md

SourceBots Documentation

CircleCI

URL: http://docs.sourcebots.co.uk

Requirements

  • Hugo (>=0.40)
  • NodeJS (>=8) (required for tests only)

Local Setup

  1. npm install
  2. git submodule update --init
  3. ./scripts/build.sh

The site will be output to public/.

Dev server

./scripts/server.sh will start a server on http://localhost:1313.

Tests

Running tests locally is optional, as they're automatically run by the CI in PRs.

Currently, the only test run is a spell-checker.

Style notes

Since our pages can almost all be accessed both with and without a trailing slash, we prefer all our links to be root-relative (i.e: /foo/bar) rather than parent-relative (i.e: ../bar).