https://github.com/mohamedsalem401/datarich-demo

https://github.com/mohamedsalem401/datarich-demo

Last synced: 25 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/mohamedsalem401/datarich-demo
• Owner: mohamedsalem401
• Created: 2024-02-27T17:33:38.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T22:32:44.000Z (5 months ago)
• Last Synced: 2024-05-29T03:03:51.908Z (5 months ago)
• Size: 488 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to our Guide on Data-Rich Documents!

Discover how to elevate your data storytelling and analysis with DataHub. This guide introduces the concept of data-rich documents, provides practical tutorials, and showcases examples to illustrate their potential.

## Tutorials

Dive into our step-by-step tutorials designed to get you started with data-rich documents:

👨‍🎓 [[datarich-tutorial|Publish data-rich stories with DataHub]]

👨‍🎓 [[frictionless-tutorial|Publishing datasets made simple with DataHub - just push a CSV + README to GitHub]]  

## Examples

Explore how data-rich documents can transform your data presentation:

👀 [[story1|Data-rich story example]]: Discover the power of storytelling combined with data visualization.

👀 [[story2|Dataset example]]: See how datasets can be presented in an accessible, visually engaging manner.

### But wait, what is a data-rich document? 

![[data-rich-document.png]]

A data-rich document is just a classic markdown document but with some superpowers to make data storytelling and analysis easy to do.

And so, in data-rich documents, the writer can easily mix formatted text content with data visualisations. This means that you don't have to code or embed your charts and tables; they can be added to the document with a very simple syntax, either by passing inline data or simply referencing your data files. What you end up with is a plain text, human-readable document enriched with data visualisations, that is simple to edit and looks awesome when published with DataHub.

#### What does the syntax look like?

The structure and text formatting of the documents are created with simple markdown. But it's not just markdown; it's markdown on steroids: writers are capable of easily adding tables of contents, mathematical formulas, data visualisations, and more!

And guess what? What you are reading right now is just this kind of data-rich document with rendering powered by DataHub. That's why we can do this:

Awesome, right? Even more awesome is that this chart is created by simply having the following snippet in this document:

```jsx

```

**Explore the Full Source:** You can check out the full source of the data-rich document you are reading [here](https://github.com/datopian/datarich-demo).

### Learn More

📚 **Supported Markdown Features:** For a full list of supported markdown features, visit [our syntax guide](https://flowershow.app/docs/syntax).

📚 **Data Visualization Components:** Explore the full list and API of available data visualisation components [here](https://storybook.portaljs.org/?path=/docs/components-table--docs).