The FAIR Data Pipeline website contains information related to the FAIR Data Pipeline, its registry, command line tool and the language-specific APIs as well as various other technical documents associated with this SCRC project.
-
FAIRDataPipeline/FDP_hugo (this repo) contains Hugo source files
- When pushes are made to this repository, a GitHub actions workflow automatically deploys source files to FAIRDataPipeline/fairdatapipeline.github.io
-
FairDataPipeline/fairdatapipeline.github.io contains website source files.
-
ScottishCovidResponse/hugo-book contains Hugo theme files
- This theme is based on the Hugo Book theme, with the search bar from the Jekyll Just the Docs theme, and some extra tweaks
- Forked from RyanJField/hugo-book
It is not necessary to build the site in order to contribute changes, but if you want to see how these will be rendered, you will need to cary out the folowing steps:
- Install
hugo extended. - Clone this repository
git clone https://github.com/FAIRDataPipeline/FDP_hugo.git. - Information regarding the directory structure of the website and how make edits to to the template (mostly in markdown) can be found here.
- In the folder that contains this repository run the command
hugo server. - The website should build locally on http://localhost:1313/.
After pushing to Github, source files should automatically be generated and the website should build online. Alternatively, click on the Edit this page link (at the bottom of each page, next to the pencil) to edit an existing page.. or email a markdown / word document and we'll put it up for you.