Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
content
content
 
 
README.md
README.md
 
 
mkdocs.yml
mkdocs.yml
 
 

README.md

pygeometa Website

The pygeometa website is powered by MkDocs which facilitates easy management of website content and publishing.

Setting up the website environment locally

# build a virtual Python environment in isolation
python3 -m venv pygeometa
cd pygeometa
# download pygeometa from GitHub
git clone https://github.com/geopython/pygeometa.git
# install required dependencies
pip3 install -r requirements-dev.txt
cd pygeometa/doc
# build the website
mkdocs build
# serve locally
mkdocs serve  # website is made available on http://localhost:8000/

Content management workflow

Overview

To manage content you require an account on GitHub. From here you can either

  1. fork the repository, make your own changes and issue a pull request, or 2. edit the content directly. For option 2 the necessary permissions are required.

The basic workflow is as follows:

  • manage content
  • commit updates
  • publish to the live site

Adding a page

vi content/new-page.md  # add content
vi mkdocs.yml  # add to navigation section
# edit any other files necessary which may want to link to the new page
git add content/new-page.md
git commit -m 'add new page on topic x' content/new-page.md mkdocs.yml
git push origin master

Updating a page

vi content/page.md  # update content
git commit -m 'update page' content/page.md
git push origin master

Publishing updates to the live site

# NOTE: you require access privileges to the GitHub repository
# to publish live updates
mkdocs gh-deploy -m 'add new page on topic x'