Awesome Open Source
Awesome Open Source

The Internals of Apache Spark Online Book

CI

The project contains the sources of The Internals of Apache Spark online book.

Tools

The project is based on or uses the following tools:

Previewing Book

Custom Docker Image

This project uses a custom Docker image (based on the Insiders image) since the official Docker image includes just a few plugins only.

Build the custom Docker image using the following command:

docker build \
  -t jaceklaskowski/mkdocs-material-insiders \
  -t jaceklaskowski/mkdocs-material-insiders:6.2.3-insiders-1.15.0 \
  .

Building Book

Run the following command to build the book.

docker run \
  -it \
  -p 8000:8000 \
  -v ${PWD}:/docs \
  jaceklaskowski/mkdocs-material-insiders \
  build --clean

TIP: Consult the Material for MkDocs documentation to get started.

Live Editing

Start mkdocs serve (with --dirtyreload for faster reloads) as follows:

docker run \
  -it \
  -p 8000:8000 \
  -v ${PWD}:/docs \
  jaceklaskowski/mkdocs-material-insiders \
  serve --dirtyreload --verbose --dev-addr 0.0.0.0:8000

You should start the above command in the project root (the folder with mkdocs.yml).

No Sphinx?! Why?

Read Giving up on Read the Docs, reStructuredText and Sphinx.


Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
book (394
spark (369
apache-spark (81