@sfgrp/taxonpages 0.1.0

package/templates/config/news.yml.example

@@ -0,0 +1,15 @@
+news_module:
+  index_page: # Configuration for the news listing page (/news)
+    news_per_page: 10 # Number of news items displayed per page
+    pinned_news_id: [] # IDs of news items that are always shown at the top of the list
+    layout: 'list' # Layout style for the news list: 'list' or 'cards'
+    show_date: true # Display the publication date for each news item
+
+  news_page: # Configuration for the news detail page (/news/:id)
+    show_date: true # Display the publication date of the news item
+    show_author: true # Display the author of the news item
+
+  widget: # Configuration for the news widget
+    news_count: 3 # Total number of news items shown in the widget
+    show_date: true # Display the publication date for each news item in the widget
+    show_content: true # Display a summary or content preview of the news item

package/templates/config/project.yml

@@ -0,0 +1,6 @@
+# Project metadata
+
+project_name: My project
+project_citation:
+project_url:
+project_authors:

package/templates/config/router.yml.example

@@ -0,0 +1,4 @@
+# Router configuration
+
+base_url: /taxonpages/
+hash_mode: true

package/templates/config/style/theme.css

@@ -0,0 +1,48 @@
+/* 
+:root {
+  --color-primary: 0, 0, 0;
+  --color-primary-content: 255, 255, 255;
+
+  --color-secondary: 3, 105, 161;
+  --color-secondary-content: 255, 255, 255;
+
+  --color-base-foreground: 255, 255, 255;
+  --color-base-background: 245, 247, 251;
+  --color-base-muted: 226, 232, 240;
+  --color-base-soft: 156, 163, 175;
+  --color-base-lighter: 55, 65, 81;
+  --color-base-border: 203, 213, 225;
+  --color-base-content: 0, 0, 0;
+
+  --color-map-georeference: 239, 68, 68;
+  --color-map-aggregate: 3, 115, 22;
+  --color-map-asserted: 249, 115, 22;
+  --color-map-type-material: 51, 136, 255;
+  --color-map-collection-object: 239, 68, 68;
+
+  --color-scrollbar-thumb: 156, 163, 175;
+  --color-scrollbar-track: 229, 231, 235;
+
+  --color-map-shape-opacity: 0.5;
+  --color-map-marker-opacity: 0.75;
+}
+
+.dark {
+  --color-primary: 23, 23, 23;
+  --color-primary-content: 255, 255, 255;
+  
+  --color-secondary: 14, 165, 233;
+  --color-secondary-content: 255, 255, 255;
+
+  --color-base-background: 23, 23, 23;
+  --color-base-foreground: 38,38,38;
+  --color-base-muted: 48, 48, 48;
+  --color-base-soft: 200, 200, 200;
+  --color-base-lighter: 220, 220, 220;
+  --color-base-border: 38, 38, 38;
+  --color-base-content: 255, 255, 255;
+
+  --color-scrollbar-thumb: 156, 163, 175;
+  --color-scrollbar-track: 55, 65, 81;
+}
+ */

package/templates/config/taxa_page.yml.example

@@ -0,0 +1,22 @@
+# Taxon page panel layout configuration
+# Customize which panels appear on taxon pages and their arrangement
+
+taxa_page:
+  overview:
+    panels:
+      - - - panel:gallery
+          - panel:type
+          - panel:type-specimen
+          - panel:nomenclature
+          - panel:nomenclature-references
+
+        - - panel:map
+          - panel:descendants
+          - panel:content
+          - panel:keys
+          - panel:statistics
+          - panel:sounds
+
+  biological_associations:
+    panels:
+      - - - panel:biological-associations

package/templates/config/tracker.yml.example

@@ -0,0 +1,8 @@
+issue_trackers:
+  - label: Data
+    description: E.g. missing data that I'd like to add, misspellings, or invalid data
+    url: http://www.github.com
+
+  - label: Website
+    description: E.g. a link, panel, or other feature is not working as expected
+    url: http://www.github.com

package/templates/pages/about.md

@@ -0,0 +1,44 @@
+---
+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.
+---
+
+# {{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}}_

package/templates/pages/home.md

@@ -0,0 +1,26 @@
+---
+title: The title
+lead: Taxa from your imagination to the web
+project: Your project
+---
+
+# {{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 class="w-80"/>
+
+## 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).

package/vite.config.js

@@ -0,0 +1,92 @@
+import { defineConfig } from 'vite'
+import { loadConfiguration } from './src/utils/loadConfiguration.js'
+import { VitePluginRadar } from 'vite-plugin-radar'
+import path from 'path'
+import { fileURLToPath } from 'node:url'
+import Vue from '@vitejs/plugin-vue'
+import Markdown from 'unplugin-vue-markdown/vite'
+import markdownAnchor from 'markdown-it-anchor'
+import { ViteRestart, projectStylesPlugin } from './src/plugins/vite'
+import {
+  relativeToRouterPlugin,
+  variableReplacementPlugin
+} from './src/plugins/markdown'
+import Pages from 'vite-plugin-pages'
+import './src/utils/globalVars'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * Vite configuration factory.
+ *
+ * Supports two modes:
+ * 1. Direct invocation via `vite` CLI (backward compatible) — uses __dirname as both package and project root.
+ * 2. Programmatic invocation via the taxonpages CLI — receives configEnv with packageRoot/projectRoot.
+ */
+export default (configEnv = {}) => {
+  const packageRoot = configEnv.packageRoot || __dirname
+  const projectRoot = configEnv.projectRoot || process.cwd()
+
+  const configuration = loadConfiguration(projectRoot)
+
+  return defineConfig({
+    base: configuration.base_url,
+    define: {
+      __APP_ENV__: configuration
+    },
+
+    resolve: {
+      alias: {
+        '@': path.resolve(packageRoot, './src'),
+        '~': path.resolve(projectRoot)
+      }
+    },
+
+    css: {
+      preprocessorOptions: {
+        scss: {
+          api: 'modern-compiler'
+        }
+      }
+    },
+
+    plugins: [
+      ViteRestart({ dir: [path.resolve(projectRoot, 'config/**/*.yml')] }),
+
+      projectStylesPlugin(projectRoot),
+
+      Vue({
+        include: [/\.vue$/, /\.md$/]
+      }),
+
+      Markdown({
+        wrapperComponent: 'markdown-layout',
+        markdownItSetup(md) {
+          md.use(markdownAnchor)
+          md.use(variableReplacementPlugin, {
+            variables: { ...configuration }
+          })
+          md.use(relativeToRouterPlugin, configuration)
+        }
+      }),
+
+      Pages({
+        dirs: path.resolve(projectRoot, 'pages'),
+        exclude: ['**/components/*.vue', 'components/**/*.vue'],
+        extensions: ['vue', 'md'],
+        extendRoute(route) {
+          if (route.path === '/home') {
+            route.alias = '/home'
+            route.path = '/'
+
+            return route
+          }
+        }
+      }),
+
+      VitePluginRadar({
+        ...configuration?.analytics_services
+      })
+    ]
+  })
+}