BitCurator / documentation

BitCurator Environment
https://bitcurator.github.io/documentation/
Creative Commons Attribution 4.0 International
2 stars 2 forks source link

BitCurator Environment Documentation

Welcome to the BitCurator Environment Documentation source repository. This repository holds the markdown formatted content pages, image assets, and configuration files used by the mkdocs static site generator software. The generated website is accessible at: https://bitcurator.github.io/documentation/ . The generated html pages are located in the gh-pages branch

Contributions

This site uses mkdocs. New pages may be added by creating new markdown files.md in the docs folder and/or section sub-folders.

Pages in sub-folders will be grouped alongside the rest of the folder content.

Static Site generation

The generated site is hosted in Github Pages following the deploying-your-docs - mkdocs documentation. To regenerated and deploy the site, install mkdocs locally:

Pull updates from this repository:
$ git pull origin main

Generate and deploy site:
$ mkdocs gh-deploy