Written in Livemark
(2021-10-26 22:29)

Starting a Project

Start quickly with Livemark Project Github Template

Project is the most important concept in Livemark along side with Document. You create a project that contains one or more documents and optional configuration file.

Prepare

Consider you're starting a new project called my-project:

$ mkdir my-project
$ cd my-project

Create a virtual environment (optional):

$ python3 -m venv .python
$ source .python/bin/activate

Bootstrap

Livemark requires only a few steps from zero to a published project:

First of all, create:

Fill in your configuration file:

livemark.yaml

brand:
  text: My Project
site:
  favicon: assets/favicon.ico

Draft the main page:

index.md

# My Project

It will be great here

Preview

Now we're ready to start a livereload server:

http://localhost:7000

$ livemark start
Data presentation framework for Python that generates static sites from extended Markdown with interactive charts, tables, scripts, and other features