TaxonPages is a tool to serve taxon pages for TaxonWorks projects.
- Click on "Fork" button to create your own repository from this.
- Uncheck
Copy the setup branch only
and pressSave
- After create your repo, go to
Settings > Pages
, on "Branch" selectgh-pages
and/(root)
. Then press save - After a couple of minutes, your public page should be available at
https://<yourusername>.github.io/taxonpages
- Switch to
setup
branch in your TaxonPages repository. - We provide some settings by default to setup your public pages, but API parameters are required and must be configured to get the data from your TaxonWorks project.
# config/api.yml
---
url: https://<your.taxonworks.server>/api/v1
project_token: yourprojecttoken
- Push the changes after update the configuration files inside
setup
branch - GitHub actions will build TaxonPages with the current configuration in
setup
branch and publish it to thegh-pages
branch
TaxonPages out of the box support markdown and vue for content sites. Add your content pages inside pages
folder. By default, TaxonPages use the file name to create the route.
For example, if the filename is "contributors.md" the route to access it will be http://yourtaxonpagessite/contributors
If you want to change the color palette, you can edit /config/style/theme.css
file, colors must be in RGB format.
TaxonPages use TailwindCSS framework for the style. We already provide default settings for colors and markdown. If you want to make any change to your configuration, you must do so in the config/vendor/tailwind.config.js
file. This file uses the TaxonPages configuration as a default. It is possible to overwrite it as long as you use it as a preset.