๐ŸŽฌ Getting Startedยถ

Stay here if you want a basic intro to the world of GitHub. If you just want to work on the doc folder or our documentation site https://slurp.readthedocs.io/ then skip to Documentation


This set of documentation is written in Markdown which is a lightweight and easy-to-use syntax for styling all forms of writing.

Markdown takes about 10 minutes to learn and GitHub provides its three-minute read on Mastering Markdown

Discussion about code base improvements happens in GitHub issues and on pull requests.


Basic Setupยถ

The project requires Golang, Node, Ruby, Python and more.

From the root of the repository:

python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt


Python Sphinx based slurp documentation site written mainly in Markdown. We have a local requirements file just for the Read the Docs hosting in the doc folder

cd doc || exit
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt

Files are stored in doc/source. From the doc folder you can build the HTML output files which are stored in doc/build. These local build files are ignored from Git.

cd doc || exit
make html

On Read the Docs we also have PDF and Epub versions

Fuchsia Programming Siteยถ

Fuchsia Programming is a Jekyll based site that requires Ruby which is stored in the docs folder. Donโ€™t get mixed up with doc from the documentation site above.

cd docs || exit
bundle exec jekyll serve

For ease of use and for those that donโ€™t have Ruby installed we now have a Dockerfile that runs the Fuchsia Programming site.

Run $ docker build --tag slurp . to build the image. Then to run the container:

$ docker run --publish 4000:4000 slurp

Example output:

slurp % docker run --publish 4000:4000 slurp
Configuration file: /app/docs/_config.yml
            Source: /app/docs
       Destination: /app/docs/_site
 Incremental build: disabled. Enable with --incremental
       Jekyll Feed: Generating feed for posts
                    done in 2.102 seconds.
 Auto-regeneration: enabled for '/app/docs'
    Server address:
  Server running... press ctrl-c to stop.


Logorama is a Jekyll based logo showcase site that requires Ruby

cd logorama || exit
bundle exec jekyll serve

DITA Projectยถ

DITA To PDF - Vanilla

cd eclipse-cheatsheets-to-dita-to-pdf/output || exit
dita --input=map.ditamap --format=pdf -o pdf