Kafka Demo Docs

Welcome to the Kafka Demo documentation, mastered in markdown, easily generated and viewed.

Getting Started

Clone the repo:

$ git clone [email protected]:davecharles/kafka_demo_docs.git
$ cd kafka_demo_docs

Docker Compose

Using docker-compose is recommended to get started quickly.

$ make compose-build
$ make compose-up    # run detached

Once up, navigate a browser to http://localhost:8000 to view the documentation. When you're done:

$ make compose-down

Building locally

You can just build locally, you'll need a suitable Python environment with the dependencies defined in requirements.txt installed then:

$ make html

This publishes the documentation set to build/html. Navigate a browser to file:///<path-to-repo-folder>/build/html/index.html.

---

This project is based on the sphinxdocs repository, head on over there for more details about the recommonmark extension, Sphinx and the Read the Docs theme.