search

frictionlessdata / livemark

Data presentation framework for Python that generates static sites from extended Markdown with interactive charts, tables, scripts, and other features
https://livemark.frictionlessdata.io
MIT License
95 stars 8 forks source link

Documentation feedback #211

Open roll opened 2 years ago

roll commented 2 years ago

Overview

From @pdelboca:

Livemark: The Starting a Project section lead me to an error when trying to execute livemark start . The error is No documents to build in the project. However, it did execute if I add the parameter of the index.md file to the command. $ livemark --version 0.109.0 $ codium . # to create index.md and livemark.yml $ livemark start No documents to build in the project $ livemark start index.md [I 220911 10:37:41 server:335] Serving on http://localhost:7000/ [I 220911 10:37:41 handlers:62] Start watching changes [I 220911 10:37:41 handlers:64] Start detecting changes [I 220911 10:37:45 handlers:135] Browser Connected: http://localhost:7000/ [W 220911 10:37:45 web:2271] 404 GET /assets/favicon.ico (127.0.0.1) 0.99ms

  1. In the Data Visualization section, is not clear where add that chart/code. It would be nice to say it's in the index.md . Also, copying and pasting the block code doesn't work since it uses ' instead of ` required for markdown. Some Personal Opinions: I don't find useful to have the Publish to Github tutorial so early in the process. For example the section Data Journalism gets you to the publish before even adding a chart or table. I think it adds some noise and context switch when people is trying to understand how to get a chart done. Kinda the same with the Data Collection section. I was trying to get some chart/table for my data. I found it super interesting, but I was just trying to draw a chart, not the automate a pipeline for an example I haven't finished yet. (It' a more advanced topic, so maybe would be better to have it later in the docs?)