This repository contains documentation for installing and running Hush Line, a free and open-source, self-hosted anonymous tip line that makes it easy for organizations or individuals to install and use.
Currently, you can read the documentation here.
This documentation is built using mdBook (v0.4.34).
To build or serve locally, you’ll need to install mdbook.
src/
directorytheme
directory next to the src
directory. In this theme
directory, you can overwrite a number of the mdBook default style files, including CSS styling and HTML templates. Here’s a full list of such files.mdbook serve
and open http://localhost:3000 in your browser.mdbook build
command. This commands overwrites the book
directory with all the HTML files that are your book. Ideally we’d have GitHub Pages host this directory as a public-facing website. (Here some documentation on that.)To add a new page, it’s best to add it to src/SUMMARY.md
, which serves as a kind of table of contents for the book, and then run mdbook build
. MdBook will then create a new markdown file for your new chapter.
Use sub-directories in src/
to create sub-pages.