Livemark is a static page generator that extends Markdown with interactive charts, tables, and more.

Related tags

Markdown/YAMLlivemark
Overview

Livermark

Build Coverage Registry Codebase Support

This software is in the early stages and is not well-tested

Livemark is a static site generator that extends Markdown with interactive charts, tables, scripts, and more.

Purpose

  • Improved writing experience: Now your Markdown data articles can include interactive charts, tables, a live development server, and much more.
  • Static site generator: Livemark only operates with static files - it creates an HTML file from your Mardown file.

Features

  • Open Source (MIT)
  • Full Markdown compatibility
  • Markdown extensions such as tables and charts
  • Straight-forward command-line interface
  • Live development server

Example

Take a look at the DEMO article

# Build a single document (index.md by default)
$ livemark build

# Start a livereload server
$ livemark start

Documentation

Please visit our documentation portal:

Comments
  • URL Problems using `livemark build` on Windows

    URL Problems using `livemark build` on Windows

    Overview

    I'm trying to build a simple livemark static site with a colleague and we're experiencing a very interesting problem due to operational systems differences, I believe.

    I'm using Linux ubuntu 20.04 and he's using Windows 10.

    When I run livemark start or livemark build on my ubuntu everything goes well, but when he does the same on windows it builds weird URLs. It appears that "/" is been changing to "%5C", as you can see here.

    The Github source code could be found here.

    I also tried to run livemark build --help and see if there were some options related to windows construction and also to search for something in the documentation.

    bug 
    opened by gabrielbdornas 5
  • build / start not working

    build / start not working

    Hi @roll! I am going through the docs and am getting errors when trying to build / start the site.

    First, I created a new project without an index.md and got errors, and I also tried it after creating an index.md file and got the same errors. Here are the errors:

    livemark build: 'str' object has no attribute 'setdefault'

    I also tried livemark start & got an error: AttributeError: 'str' object has no attribute 'copy'

    Then, I tried building the site from this repo and also got errors.

    livemark build: to_snap() got an unexpected keyword argument 'json'

    and

    livemark start: TypeError: to_snap() got an unexpected keyword argument 'json'

    I'm on Python 3.8 & Livemark 0.39.0

    Any ideas? Thanks!

    bug 
    opened by lwinfree 4
  • Doc: Starting project fails

    Doc: Starting project fails "No documents to build in the project"

    The page: https://github.com/frictionlessdata/livemark/blob/main/pages/getting-started/starting-project.md

    gives instructions to start a project but it fails with:

    $ livemark start
    No documents to build in the project
    

    Obvious reason is, that the file livemark.yaml is incomplete:

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

    as it does not contain any pages section so there is nothing to build.

    documentation 
    opened by vlcinsky 2
  • aways use posix paths on generated relative paths in html

    aways use posix paths on generated relative paths in html

    • fixes #205

    With livemark is used in Windows, outside a POSIX compliant system the generated URLs inside the generated HTML will have Window back slashes (\folder\file instead of /folder/file). This happens because of how gel_relapath is generating the path using os.path.join. os.path always follows the format of the current OS, this means, if you are in windows it is going to use back slashes. The problem happens that urls follow POSIX path, with this slash /.

    I don't know if there are other places that we need to change the paths to POSIX ones. If we just change everywhere that os.path is used, this will causes problems for windows user when livemark need to open a file somewhere.

    bug 
    opened by aivuk 2
  • Install error

    Install error

    Overview

    Hi @roll , first of all: this is great idea, a great product, thank you very much 🙏🙏🙏.

    When I install it, I have this error:

    ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
    mkdocs-rss-plugin 0.17.0 requires Jinja2<3,>=2, but you have jinja2 3.0.2 which is incompatible.
    jinja-markdown 1.200630 requires Jinja2~=2.11, but you have jinja2 3.0.2 which is incompatible.
    datapackage-pipelines 2.2.6 requires python-dateutil<2.8.1, but you have python-dateutil 2.8.1 which is incompatible.
    

    Does the only solution is to use virtualenv?

    Thank you

    Please preserve this line to notify @roll (lead of this repository)

    opened by aborruso 2
  • `pip install` downloads all versions

    `pip install` downloads all versions

    Installing with the recommended approach (pip install livemark) or a fresh virtual environment with pip, setuptools, and wheel up to date currently takes a long time, as the frictionless requirement is set with a star: https://github.com/frictionlessdata/livemark/blob/cd4200f143dfe6d77874de23e8c13a1cbeea0e08/setup.py#L48

    Due to requirement settings in dependencies, it means that pip also downloads multiple versions of other libraries (livemark itself, simpleeval, etc.). In a non-fresh environment (e.g. one in which frictionless is already installed) it might lead to conflicts during installation, but I was not able to immediately reproduce it (maybe it depends on the order the packages are installed). The multiple downloads were reproduced both under the latest stable Ubuntu (with Python3.8) and WSL.

    bug 
    opened by tresoldi 2
  • Test different basepath scenarios

    Test different basepath scenarios

    Overview

    Currently, it works fine on localhost and https://livemark.frictionlessdata.io/ but there might be basepath problems e.g. on GIthub Pages without a custom domain.

    bug duplicate 
    opened by roll 2
  • Finish the documentation

    Finish the documentation

    Overview

    It needs to be finished for version 1

    Plan

    • [ ] structure: logic, table, chart, script, markup, sidebars, widgets, config, plugins?
    • [ ] improve current articles
    • [ ] add new articles
    • [ ] update the main (demo) page
    • [ ] update the readme (features)
    enhancement 
    opened by roll 2
  • quick edit

    quick edit

    I quickly read thru all the pages & fixed typos/grammar.

    I can merge this @roll but I'll wait until tomorrow in case you have time & want to look first.

    The documentation is looking really nice!!

    opened by lwinfree 1
  • Rebase default template on using Github Templates

    Rebase default template on using Github Templates

    Overview

    We have a Github Template for Livemark project - https://github.com/frictionlessdata/livemark-project. We need to use it instead of livemark/assets/documents/template.md to avoid duplication.

    duplicate enhancement 
    opened by roll 1
  • Consider supporting slow scripts within build/start

    Consider supporting slow scripts within build/start

    Overview

    Currently, even though with caching it's not a good idea to have long-running scripts in the script snippet because every livemark build/start; it will be fully executed (although cached during the start session).

    ATM we need to write separate scripts to fetch the data and we can include it to the site using FilePlugin. We might consider some special options like slow tags/etc to include these scripts to Livemark makrdown. It's something to investigate.

    enhancement 
    opened by roll 1
  • Add collapsed/hidden plugin

    Add collapsed/hidden plugin

    Overview

    It's really popular feature for the writing engines - an ability to have some sections hidden by default with an ability to expand by a reader

    feature 
    opened by roll 0
Releases(v0.110.1)
Owner
Frictionless Data
Lightweight specifications and software to shorten the path from data to insight. Code of Conduct: https://frictionlessdata.io/code-of-conduct/
Frictionless Data
Lightweight Markdown dialect for Python desktop apps

Litemark is a lightweight Markdown dialect originally created to be the markup language for the Codegame Platform project. When you run litemark from the command line interface without any arguments,

10 Apr 23, 2022
A lightweight and fast-to-use Markdown document generator based on Python

A lightweight and fast-to-use Markdown document generator based on Python

快乐的老鼠宝宝 1 Jan 10, 2022
Rich-cli is a command line toolbox for fancy output in the terminal

Rich CLI Rich-cli is a command line toolbox for fancy output in the terminal, built with Rich. Rich-cli can syntax highlight a large number of file ty

Textualize 2.5k Jan 02, 2023
Yuque2md - Offline download the markdown file and image from yuque

yuque2md 按照语雀知识库里的目录,导出语雀知识库中所有的markdown文档,并离线图片到本地 使用 安装 Python3.x clone 项目 下载依

JiaJianHuang 4 Oct 30, 2022
A minimal platform for Markdown-based blogs

madblog This project provides a minimal blogging platform based on Markdown files. Demos This project powers the following blogs: Platypush My persona

Fabio Manganiello 2 Aug 02, 2022
Provides syntax for Python-Markdown which allows for the inclusion of the contents of other Markdown documents.

Markdown-Include This is an extension to Python-Markdown which provides an "include" function, similar to that found in LaTeX (and also the C pre-proc

Chris MacMackin 85 Dec 30, 2022
A automated python script that creates mark-down files to read for the aes keys and other useful information.

Archive A automated python script that creates mark-down files to read for the aes keys and other useful information. Table of Contents Benbot Automat

Tector 13 Dec 14, 2022
Toci is a markdown tool to generate an outline from a given Jupyter notebook.

Toci is a markdown tool to generate an outline from a given Jupyter notebook. It traverses the markdown cells of a given ipynb file to form a toc for you.

Hakan Özler 7 Jan 22, 2022
A super simple script which uses the GitHub API to convert your markdown files to GitHub styled HTML site.

A super simple script which uses the GitHub API to convert your markdown files to GitHub styled HTML site.

Çalgan Aygün 213 Dec 22, 2022
WyPyPlus is a minimal wiki in 42 lines of Python code.

🍦 WyPyPlus: A personal wiki in 42 lines of code 🍦 WyPyPlus (pronounced "whippy plus") is a minimalist wiki server in 42 lines of code based on wypy

Leo Chen 8 Apr 07, 2022
Preview GitHub README.md files locally before committing them.

Grip -- GitHub Readme Instant Preview Render local readme files before sending off to GitHub. Grip is a command-line server application written in Pyt

Joe Esposito 5.9k Jan 08, 2023
Markdown parser, done right. 100% CommonMark support, extensions, syntax plugins & high speed. Now in Python!

markdown-it-py Markdown parser done right. Follows the CommonMark spec for baseline parsing Configurable syntax: you can add new rules and even replac

Executable Books 398 Dec 24, 2022
Livemark is a static page generator that extends Markdown with interactive charts, tables, and more.

Livermark This software is in the early stages and is not well-tested Livemark is a static site generator that extends Markdown with interactive chart

Frictionless Data 86 Dec 25, 2022
Convert mind maps to markdown for import into Roam.

Mind Map to Markdown for Roam import Got a Mind Map with contents you'd like to import into Roam? Soon, this Python application might do what just you

Romilly Cocking 3 Dec 09, 2021
A fast, extensible and spec-compliant Markdown parser in pure Python.

mistletoe mistletoe is a Markdown parser in pure Python, designed to be fast, spec-compliant and fully customizable. Apart from being the fastest Comm

Mi Yu 546 Jan 01, 2023
Extensions for Python Markdown

PyMdown Extensions Extensions for Python Markdown. Documentation Extension documentation is found here: https://facelessuser.github.io/pymdown-extensi

Isaac Muse 685 Jan 01, 2023
markdown2: A fast and complete implementation of Markdown in Python

Markdown is a light text markup format and a processor to convert that to HTML. The originator describes it as follows: Markdown is a text-to-HTML con

Trent Mick 2.4k Dec 30, 2022
A markdown lexer and parser which gives the programmer atomic control over markdown parsing to html.

A markdown lexer and parser which gives the programmer atomic control over markdown parsing to html.

stonepresto 4 Aug 13, 2022
A fast yet powerful Python Markdown parser with renderers and plugins.

Mistune v2 A fast yet powerful Python Markdown parser with renderers and plugins. NOTE: This is the re-designed v2 of mistune. Check v1 branch for ear

Hsiaoming Yang 2.2k Jan 04, 2023
Read a list in markdown and do something with it!

Markdown List Reader A simple tool for reading lists in markdown. Usage Begin by running the mdr.py file and input either a markdown string with the -

Esteban Garcia 3 Sep 13, 2021