iver-wharf / iver-wharf.github.io

Documentation of Wharf

Wharf documentation

This repo contains a Docsify.js site that's hosted via GitHub Pages over at https://iver-wharf.github.io/.

Build locally

1. Install Node.js: https://nodejs.org/en/download/

2. Install Docsify.js dependencies using NPM:

   npm install

3. Start Docsify's local server (that supports hot-reloading!)

   npm start

4. Visit http://localhost:3000

Linting

make deps # download linting dependencies

make lint

make lint-md # only lint Markdown files

Some errors can be fixed automatically. Keep in mind that this updates the files in place.

make lint-fix

make lint-fix-md # only lint and fix Markdown files

---

Maintained by Iver. Licensed under the MIT license.