Skip to content

falkogloeckler/website

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TDWG website

This repository contains the content and settings for the TDWG website. It is generated as a static website with Pelican.

Getting started

Repo structure

├── README.md                 : Description of this repository
│
├── content                   : Website content. Each news item/page is a directory, containing at least an index.md
│   ├── articles              : News items, organized by year
│   └── pages
│       ├── home              : Homepage
│       ├── standards         : Standards pages
│       ├── journal           : BISS page
│       ├── community         : Interest, Task and Maintenance Groups pages
│       ├── conferences       : Conference landing pages
│       └── about             : Executive, constitution, contact, etc. pages
│
├── settings.py, settings-prod.py : Generic website settings
├── requirements.txt          : Python requirements for Pelican
│
├── LICENSE                   : Repository license
├── .github                   : Contributing guide, issue templates
└── .gitignore                : Files and directories to be ignored by git

Deployment

tdwg.org is rebuilt automatically for any change on the master branch in this repository or the tdwg-theme repository. You can see the status of the builds at https://builds.gbif.org/job/tdwg-website/. If you want to build the website locally, do the following:

Installation

  1. Clone the website repo: git clone https://github.com/tdwg/website
  2. Clone the theme repo: git clone https://github.com/tdwg/tdwg-theme
  3. Optional: create a virtual environment (e.g. conda create -n tdwg python=3.7) and activate it (e.g. source activate tdwg)
  4. Verify Python 3.3+ is installed: python --version
  5. Navigate to the website repo and install the requirements (including Pelican): pip install -r requirements.txt

Build site

  1. Optional: activate your virtual environment (e.g. source activate tdwg)
  2. Navigate to the website directory: cd website
  3. Build the site locally: pelican -s settings.py
  4. The website is generated in output/ which you can serve with e.g. python -m http.server 8000

Contributors

List of contributors

License

This work is licensed under the Creative Commons Attribution 4.0 International License.

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.8%
  • HTML 5.2%