Quickstart¶

Follow the installation instructions to get disseminate working.

Terminal¶

Step 1: Setup a project¶

A disseminate project is a collection of documents that come together to render into textbooks, books, articles or essays.

The simplest project consists of a single document, typically in its own directory.

  $ mkdir MyBook
  $ cd MyBook
  $ mkdir src

Step 2: Create a first document¶

In your favorite text editor, edit a first document (src/main.dm).

---
title: My first document
author: John A. Doe
targets: html
---
@chapter{This is my first chapter}

I am @i{here} to show you how this works.

Step 3: Build the document¶

Use disseminate to build the document.

  $ dm build
  Build: done
  $ find . -type f
  ./html/main.html
  ./html/media/css/bootstrap.min.css
  ./html/media/css/default.css
  ./html/media/css/pygments.css
  ./html/media/css/base.css
  ./html/media/icons/tex_icon.svg
  ./html/media/icons/menu_inactive.svg
  ./html/media/icons/menu_active.svg
  ./html/media/icons/epub_icon.svg
  ./html/media/icons/txt_icon.svg
  ./html/media/icons/pdf_icon.svg
  ./html/media/icons/dm_icon.svg
  ./.cache/md5decider/cache.db-shm
  ./.cache/md5decider/cache.db-wal
  ./.cache/md5decider/cache.db
  ./src/main.dm

Step 4: View the document¶

Use the disseminate previewer to view the document website.

  $ dm preview
  [2020-11-05 12:44:48 -0600] [56581] [INFO] Goin' Fast @ http://127.0.0.1:8899
  [2020-11-05 12:44:48 -0600] [56581] [INFO] Starting worker [56581]

Use a web browser to visit the webserver on your computer at http://127.0.0.1:8899. This will present the document index for your project.

../_images/Disseminate Document Listing.svg

Clicking on the html link will show the html rendered version of your document.