Data Package
A simple container format for describing a coherent collection of data in a single package.
Data Package
A simple container format for describing a coherent collection of data in a single package.
Data Package
A simple container format for describing a coherent collection of data in a single package.
```
--------------------------------
### Configure footer notes format
Source: https://livemark.frictionlessdata.io/pages/feature-reference/appearance.html
Defines the date format for the last updated timestamp shown in the footer.
```yaml
notes:
format: %Y-%m-%d
```
--------------------------------
### Render a Table Schema
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Displays an interactive table schema based on a JSON descriptor file.
```yaml
'''yaml schema
descriptor: data/cars.schema.json
'''
```
--------------------------------
### Add external links to site configuration
Source: https://livemark.frictionlessdata.io/pages/feature-reference/navigation.html
Define external links to appear in the right column of the website.
```yaml
links:
items:
- name: Frictionless
path: https://frictionlessdata.io
- name: Discord
path: https://discord.com/channels/695635777199145130/695635777199145133
- name: Twitter
path: https://twitter.com/frictionlessd8a
```
--------------------------------
### Render Vega Lite Chart
Source: https://livemark.frictionlessdata.io/index.html
Use the yaml chart block to define visualisations. Replace single quotes with backticks to render.
```yaml
'''yaml chart
data:
url: data/cars.csv
mark: circle
selection:
brush:
type: interval
# other options are omitted
width: 500
height: 300
'''
```
--------------------------------
### Embed Audio or SoundCloud
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Renders an audio file or SoundCloud track using a unique identifier.
```yaml
'''yaml audio/soundcloud
code: 34445479
'''
```
--------------------------------
### Add site news banner
Source: https://livemark.frictionlessdata.io/pages/feature-reference/appearance.html
Displays a news message at the top of the site.
```yaml
news:
text: It's test news
```
--------------------------------
### Override configuration with document frontmatter
Source: https://livemark.frictionlessdata.io/pages/getting-started/configuration.html
Use YAML frontmatter at the top of a markdown file to set document-specific configurations that take priority over project settings.
```yaml
---
site:
title: My Title
---
# My Document
```
--------------------------------
### Enable repository star rating
Source: https://livemark.frictionlessdata.io/pages/feature-reference/appearance.html
Configures the display of a GitHub repository's star rating based on the Github feature setting.
```yaml
rating:
type: start
```
--------------------------------
### Embed Data Visualizations
Source: https://livemark.frictionlessdata.io/pages/guides-and-tutorials/data-journalism.html
Using the chart extension to render data visualizations within Markdown.
```yaml
'''yaml chart
data:
url: ../../data/cars.csv
mark: circle
selection:
brush:
type: interval
# other options are omitted
width: 500
height: 300
'''
```
--------------------------------
### Configure table of contents selector
Source: https://livemark.frictionlessdata.io/pages/feature-reference/navigation.html
Specify the heading level used for the automatically generated table of contents in the project configuration.
```yaml
topics:
selector: h2
```
--------------------------------
### Process tabular data with Jinja
Source: https://livemark.frictionlessdata.io/index.html
Use the frictionless variable to iterate over CSV resources within Jinja templates.
```jinja
{% for car in frictionless.Resource('data/cars.csv').read_rows(size=5) %}
- {{ car.brand }} {{ car.model }}: ${{ car.price }}
{% endfor %}
```
--------------------------------
### Render a Video
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Embeds a video file or a YouTube video using a unique identifier.
```yaml
'''yaml video/youtube
code: NMg-eCbO6L0
'''
```
--------------------------------
### Define Tasks in Markdown
Source: https://livemark.frictionlessdata.io/pages/guides-and-tutorials/python-development.html
Syntax for defining bash and python tasks within a Markdown file using task IDs.
```markdown
'''bash task id=test-lint
echo 'Test Lint'
'''
'''python task id=test-code
print('Test Code')
'''
```
--------------------------------
### Render a Validation Report
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Displays an interactive validation report based on a JSON descriptor file.
```yaml
'''yaml report
descriptor: data/invalid.report.json
'''
```
--------------------------------
### Render a GeoJSON Map
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Use the map directive to visualize GeoJSON data. Replace single quotes with backticks to execute.
```yaml
'''yaml map
data: data/france.json
'''
```
--------------------------------
### Create a Custom Plugin
Source: https://livemark.frictionlessdata.io/pages/plugin-system/writing-plugin.html
Defines a custom plugin class inheriting from Plugin that modifies H1 tags by injecting a span element.
```python
from livemark import Plugin
class CustomPlugin(Plugin):
identity = "custom"
# Process
def process_markup(self, markup):
markup.add_markup("(template)", target="h1")
```
--------------------------------
### Snippet (class)
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Represents a Livemark snippet. Provides properties to access snippet metadata and a process method to handle document integration.
```APIDOC
## Snippet(input: str, *, header: List[str])
### Description
Initializes a new Snippet instance.
### Parameters
- **input** (str) - Required - Textual snippet content.
- **header** (List[str]) - Required - An array of the snippet's header.
### Properties
- **header** (List[str]) - Snippet's header.
- **input** (str) - Snippet's input.
- **lang** (str) - Snippet's lang.
- **output** (Optional[str]) - Snippet's output.
- **props** (Dict[str, Any]) - Snippet's props.
- **type** (str) - Snippet's type.
### Methods
- **process(document: Document) -> None** - Process the snippet within a given document.
```
--------------------------------
### Define Data Tasks in Markdown
Source: https://livemark.frictionlessdata.io/pages/guides-and-tutorials/data-journalism.html
Embedding bash and python tasks directly into Markdown files for data processing workflows.
```markdown
'''bash task id=data-extract
echo 'Data Extract'
'''
'''python task id=data-transform
print('Data Transform')
'''
'''python task id=data-load
print('Data Load')
'''
```
--------------------------------
### Define a Python task
Source: https://livemark.frictionlessdata.io/pages/feature-reference/markdown.html
Use the task identifier in the code block header to define a runnable Python script.
```python
'''python task id=example
print('It is a task')
'''
```
=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.