Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.24 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.24 KB
Raw

Napkin Wiki

This is jekyll based wiki with just-the-docs theme.

To build locally run:

nix-shell

Wiki would be available by http://localhost:4000 in a browser.

The officially published version is available at github pages.

Commit and push to the master branch to publish a new version.

Nonetheless Github Pages can generate HTML out of jekyll files on-the-fly - custom Gitlab pipeline is configured, because the service provides obsolete gems and can fail with obscure errors. The custom pipeline gives consistent behavior across CI server and local environment.

The repo with rendered HTML is here.

Locally HTML output is rendered into _site folder.

Style-Guide

  • Napkin should always capitalized except when in code (e.g. napkin.run doesn’t need to be capitalized)
  • Spec is always capitalized except when used in code (e.g. spec.yaml doesn’t need to be capitalized)
  • Always capitalize SQL operators
  • Update last_modified_at field in Front Matter if you change a page, because it affects sitemap.xml.

Adding new Jekyll gems and plugins

Use gen-gemset.sh to update nix setup for new Jekyll plugins.