datapackage | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Welcome to the body of your site. Everything above this section is part of the Data package front matter. I am adding here markdown text and other data-rich elements and they render beautifully.
Here is a quick overview of the template you're looking at:
![[Overview.png]]
We have a frontmatter at the top, followed by the "body" of your site, which consists of unstructured data and/or data-rich components.
Feel free to customize the data package frontmatter accordingly when publishing your own data.
[!info] Frontmatter refers to the metadata placed at the beginning of the markdown file enclosed within triple dashes (---). This metadata provides essential information about the file and its content, enabling better organization, configuration, and processing by tools and platforms.
graph TD;
Data-Package-Frontmatter-->Dataset-title
Data-Package-Frontmatter-->Data-package-metadata
Data-Package-Frontmatter-->Short-description;
Data-Package-Frontmatter-->Data-files-list;
Data-Package-Frontmatter-->Data-Previews;
This is the frontmatter in this README.md:
---
datapackage:
title: Welcome to your template dataset page!
description: This is a template for publishing your dataset with Datahub Cloud.
created: 2024-01-01
updated: 2024-01-31
licenses:
- path: http://opendatacommons.org/licenses/pddl/
title: Open Data Commons Public Domain Dedication and License v1.0
sources:
- path: http://link.to/data/source
title: Link to data source
resources:
- name: c02-per-decade
title: C02 PPM per decade
description: C02 PPM per decade
lastModified: 2024-01-15
path: data.csv
---
You can either update it if you have some data files / datasets that you would want to publish or delete it completely if you have markdown content only (suitable for blogs, data stories, articles, etc.)
You can add as many markdown files to your GitHub repository as you like, and you can freely nest them in subdirectories. You can also enhance your content with other data visualisation components and markdown features.
Note: For a full list of supported markdown features visit Markdown syntax support
Here are some quick examples:
[!info] This is cool! Here's a callout block. It supports markdown and
[[Internal link|wikilinks]]
.
Or you can quickly embed a piece of code as follows:
const ExampleCode = () => {
return <div> .... </div>;
};
This template works best for datasets. If you don't have any data files, we suggest checking out the other templates here https://datahub.io/docs#templates
You can add some visuals (graphs, charts) to make your dataset more impactful or add sidebar navigation in case you have a collection of datasets. Or you could customize your site with CSS and HTML or configure SEO fields, etc. See below:
Important
For any questions, refer to the Docs
Warning
Just testing some callout blocks here.
[!done] Test passed.
I will add a data table from my data.csv file below: <FlatUiTable data={{ url: 'data.csv' }} />
Looks kinda cool. What about a linechart? Let's see what this would look like: <LineChart data={{ url: 'data.csv' }} title="C02 PPM per decade" xAxis="year" yAxis="value" color="key" />
<LineChart data={{ url: 'data.csv' }} title="C02 PPM per decade" xAxis="year" yAxis="co2" color="key" />
<LineChart data={{ values: [ { date: '2019-01-01', foo: 10, bar: 10, key: 30 }, { date: '2020-01-02', foo: 30, bar: 20, key: 20 }, { date: '2021-01-03', foo: 40, bar: 20, key: 10 }, { date: '2022-01-04', foo: 1, bar: 60, key: 20 } ] }} title="CO2 PPM per Decade" xAxis="date" color="key" />
<LineChart data={{ values: [ { date: '2019-01-01', foo: 10, bar: 10, key: 30 }, { date: '2020-01-02', foo: 30, bar: 20, key: 20 }, { date: '2021-01-03', foo: 40, bar: 20, key: 10 }, { date: '2022-01-04', foo: 1, bar: 60, key: 20 } ] }} title="CO2 PPM per Decade" xAxis="foo" color="key" />
<LineChart data={{ values: [ { date: '2019-01-01', foo: 10, bar: 10, key: 30 }, { date: '2020-01-02', foo: 30, bar: 20, key: 20 }, { date: '2021-01-03', foo: 40, bar: 20, key: 10 }, { date: '2022-01-04', foo: 1, bar: 60, key: 20 } ] }} title="CO2 PPM per Decade" xAxis="foo" yAxis="value" color="Values" />
If you want to explore more of what's possible: