Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor improvements #955

Merged
merged 4 commits into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions astro.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ export default defineConfig({
integrations: [
starlight({
title: "Data Package Standard",
description:
"Data Package is a standard consisting of a set of simple yet extensible specifications to describe datasets, data files and tabular data. It is a data definition language (DDL) and data API that facilitates findability, accessibility, interoperability, and reusability (FAIR) of data.",
logo: {
light: "/assets/logo-light.svg",
dark: "/assets/logo-dark.svg",
Expand All @@ -32,6 +34,7 @@ export default defineConfig({
customCss: ["/assets/styles.css"],
tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 5 },
components: {
MarkdownContent: "./components/MarkdownContent.astro",
SocialIcons: "./components/SocialIcons.astro",
},
plugins: [
Expand Down
12 changes: 12 additions & 0 deletions components/MarkdownContent.astro
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
import type { Props } from "@astrojs/starlight/props"
import Default from "@astrojs/starlight/components/MarkdownContent.astro"
---

<Default {...Astro.props}><slot /></Default>

<script>
import { addBackToTop } from "vanilla-back-to-top"

addBackToTop({ backgroundColor: "#3272C2", scrollDuration: 200 })
</script>
1 change: 0 additions & 1 deletion components/SocialIcons.astro
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ import Default from "@astrojs/starlight/components/SocialIcons.astro"
>
<a href="https://specs.frictionlessdata.io/"><strong>v1</strong></a>

<!-- Render the default social links. -->
<Default {...Astro.props}><slot /></Default>

<!-- Add styles to mimic the default links appearance. -->
Expand Down
2 changes: 0 additions & 2 deletions content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Data Package
description: |
Data Package standard.
template: splash
editUrl: false
hero:
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/data-package.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data Package
description: A simple container format for describing a coherent collection of data in a single 'package'. It provides the basis for convenient delivery, installation and management of datasets.
sidebar:
order: 1
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/data-resource.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Data Resource
description: A simple format to describe and package a single data resource such as a individual table or file. The essence of a Data Resource is a locator for the data it describes. A range of other properties can be declared to provide a richer set of metadata.
sidebar:
order: 2
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/extensions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Extensions
description: The Data Package Standard extensibility features for domain-specific needs.
sidebar:
order: 5
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/glossary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Glossary
description: A glossary of terms used in the Data Package standard.
sidebar:
order: 6
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/security.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Security
description: Security considerations around Data Packages and Data Resources.
sidebar:
order: 7
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/table-dialect.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Table Dialect
description: Table Dialect describes how tabular data is stored in a file. It supports delimited text files like CSV, semi-structured formats like JSON and YAML, and spreadsheets like Microsoft Excel.
sidebar:
order: 3
---
Expand Down
1 change: 1 addition & 0 deletions content/docs/standard/table-schema.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Table Schema
description: Table Schema is a simple language- and implementation-agnostic way to declare a schema for tabular data.
sidebar:
order: 4
---
Expand Down
Loading