Skip to content

Commit

Permalink
Add default configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
José Luis Pereira committed Jul 26, 2022
0 parents commit dc86ae0
Show file tree
Hide file tree
Showing 9 changed files with 97 additions and 0 deletions.
3 changes: 3 additions & 0 deletions config/api.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
url:
project_token:
4 changes: 4 additions & 0 deletions config/copyright.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
copyright_image:
copyright_image_link:
copyright_text: "Copyright CC0"
8 changes: 8 additions & 0 deletions config/header.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
logo_url:
links:
- label: Home
link: /

- label: About
link: /about
2 changes: 2 additions & 0 deletions config/mapping.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
map_server_tils: https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png
5 changes: 5 additions & 0 deletions config/project.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
project_name: "My project"
project_citation: "My project"
project_url: "yourprojecturl"
project_authors: "Gandalf"
3 changes: 3 additions & 0 deletions config/router.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
base_url: /
hash_mode: false
5 changes: 5 additions & 0 deletions config/vendor/tailwind.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
presets: [
require(__basedir + '/tailwind.config.js')
]
}
41 changes: 41 additions & 0 deletions pages/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: About
contact_email: user@example.com
copyright: All content is CC 0 so that it maybe be shared throughout the world in places like Wikipedia.
citation: Project collaborative. 2022. Website title. Available at https://example.com.
---
<div class="container mx-auto mt-4 pl-4 pr-4">
<div class="prose dark:prose-invert lg:prose-base max-w-none">

# {{frontmatter.title}}

## Dig deeper
Please contact us if you need extended access to the data underlying here. The TaxonWorks interfaces used to curate these data include wide range of additional filtering, reporting, and curatorial functionality. With a little training from us we'd be happy to provide you access to this additional functionality. Over time we expect this site to gradually mirror that extended functionality.

## Contact
If you have a question, want to report new data relevant to the project, or have error our preferred means of contact is to file an issue on our [project tracker](https://github.com/our/project/tracker). You can also [chat live with us](https://slackservername). We can also be reached via [email](mailto:{{frontmatter.contact_email}}).

## Team
_Please contact us if you would like to join this effort._

Made possible by the wonderful:
* Gandalf - Technical lead
* Aragorn - Outside advisor
* Frodo - Lead curator
* Samwise - Emotional support

## Citing
* This website - {{frontmatter.citation}}
* Individual taxon pages - See citation at the bottom of each page.

## Data
Data for these pages is collaboratively curated online in a [TaxonWorks](https://taxonworks) project. All data behind this site served as JSON through calls to a [TaxonWorks API](https://api.taxonworks.org). You can follow along by using the Console of your browser to explore the Network tab.

## Technical
Want to create your own site? This website is built completely on open-source software. There is a [site template](https://github.com/SpeciesFileGroup/<something>) with more information. Data are curated in a [TaxonWorks](https://taxonworks.org) project then shared via a [TaxonWorks API](https://api.taxonworks.org). Come [chat](https://gitter.im/SpeciesFileGroup/taxonworks) with the TaxonWorks community at any time.

## Copyright
_{{frontmatter.copyright}}_

</div>
</div>
26 changes: 26 additions & 0 deletions pages/home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: The title
lead: Taxa from your imagination to the web
project: Your project
---
<div class="container mx-auto mt-4 pl-4 pr-4">
<div class="prose dark:prose-invert lg:prose-base max-w-none">

# {{frontmatter.title}}
_{{frontmatter.lead}}_

## Overview
Welcome to *{{ frontmatter.project }}*, a website of taxon pages generated from the {{ frontmatter.project }} Project, a comprehensive collaborative effort managed in [TaxonWorks](https://taxonworks.org).

## Get started!
<autocomplete-otu/>

## Announcements
* 5/1/2022 - We've grown!
* 1/1/2022 - Our website is live!

## Find out more
Learn how to collaborate with the {{ frontmatter.title }} project. Contact information, technical details, and more are available at [About](/about).

</div>
</div>

0 comments on commit dc86ae0

Please sign in to comment.