Skip to content

Commit f8548ab

Browse files
lwjohnst86signekbmartonvago
authored
docs: 📝 add landing page to website (#107)
# Description Closes #22 Needs a thorough review. ## Checklist - [x] Formatted Markdown - [x] Ran `just run-all` --------- Co-authored-by: Signe Kirk Brødbæk <40836345+signekb@users.noreply.github.com> Co-authored-by: martonvago <57952344+martonvago@users.noreply.github.com>
1 parent 19fada5 commit f8548ab

File tree

2 files changed

+89
-1
lines changed

2 files changed

+89
-1
lines changed

_metadata.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
gh:
22
repo: seedcase-flower
33
org: seedcase-project
4+
5+
links:
6+
github: "https://github.com/seedcase-project/seedcase-flower"

index.qmd

Lines changed: 86 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,88 @@
11
---
2-
title: "Welcome!"
2+
toc: false
3+
page-layout: custom
34
---
5+
6+
::::: landing-page-block
7+
:::: hero-text
8+
::: text-center
9+
![](_extensions/seedcase-project/seedcase-theme/logos/flower/icon.svg){fig-alt="Seedcase Flower logo."
10+
width="150px"}
11+
12+
![](_extensions/seedcase-project/seedcase-theme/logos/flower/font.svg){fig-alt="Seedcase Flower font."
13+
height="50px"}
14+
15+
## Turn your Data Package metadata into human-readable documentation
16+
17+
[Overview](/docs/index.qmd){.btn .about-link} [Explore
18+
guide](/docs/guide/index.qmd){.btn .about-link}
19+
:::
20+
::::
21+
:::::
22+
23+
:::: landing-page-block
24+
::: {#hero-heading}
25+
{{< include /docs/includes/_badges.qmd >}}
26+
:::
27+
::::
28+
29+
::::: hero-banner
30+
:::: landing-page-block
31+
::: hero-text
32+
Flower is a Python package and command-line interface (CLI) that
33+
generates human-readable documentation from your [Data
34+
Package](https://datapackage.org/) metadata.
35+
36+
## :sparkles: Key features
37+
38+
- Create structured and human-friendly documents from a Data Package's
39+
`datapackage.json` file.
40+
- Display the contents of a `datapackage.json` file in a
41+
human-friendly way directly in the terminal.
42+
- Use through the command line for convenience, speed, and automation.
43+
- Comes with multiple built-in styles and supports custom styles with
44+
[Jinja2](https://jinja.palletsprojects.com/en/stable/) templates.
45+
- Configurable through the `.flower.toml` file for reproducible
46+
document generation for your Data Package.
47+
48+
Flower focuses on generating documents. For rendering, publishing, or
49+
deploying, see our
50+
[`template-data-package`](https://template-data-package.seedcase-project.org/).
51+
:::
52+
::::
53+
:::::
54+
55+
::::: landing-page-block
56+
:::: hero-text
57+
## About the Seedcase Project
58+
59+
Flower is part of the [**Seedcase
60+
Project**](https://seedcase-project.org), which helps research projects
61+
manage and process data in line with the
62+
[FAIR](https://www.go-fair.org/fair-principles/) principles.
63+
64+
This package works as a standalone tool but is also integrated into our
65+
[`template-data-package`](https://template-data-package.seedcase-project.org/)
66+
template, which makes it easier to set up, build, and manage a Data
67+
Package.
68+
69+
::: text-center
70+
[Check out Seedcase](https://seedcase-project.org/){.btn .about-link}
71+
[Explore the
72+
template](https://template-data-package.seedcase-project.org/){.btn
73+
.about-link}
74+
:::
75+
::::
76+
:::::
77+
78+
::::: hero-banner
79+
:::: landing-page-block
80+
::: hero-text
81+
## Want to contribute?
82+
83+
We would love your feedback or contributions! Head over to the [GitHub
84+
repository]({{< meta links.github >}}) to share your ideas or contribute
85+
code. Your input makes us better!
86+
:::
87+
::::
88+
:::::

0 commit comments

Comments
 (0)