This site provides the public-facing website for the GeoBlacklight community.
Markdown is a lightweight and easy-to-use language for text documents.
MkDocs is a static site generator platform that allows users to create and maintain documentation websites. It takes Markdown files and uses the Python-Markdown library to convert the documents to HTML.
Material is the most actively developed theme available for MkDocs (as of 2023) and features flexible navigation and many plugins to extend what we can do with Markdown. It is called "Material" because it is based on Google's Material Design guidelines.
GitHub Pages is a free static site hosting service offered by GitHub.
This is the working branch containing the content for the site using Markdown.
docs folder
/blog
.authors.yml
: a list of blog authors and their GitHub usernamesindex.md
: a mostly blank page used by the blog plugin/posts/
: collection of blog posts in markdown /images
: image files for general pages/pdfs
: PDF files/showcase
index.md
: all the GeoBlacklight instances listed on the showpage/stylesheets
extra.css
: a CSS file that can define colors, fonts, and other customizations for the site
/docs
: technical documentation pages. Note that this has the same name as the root folder for all the pages! We use this name so that the documentation pages will appear in a subdirectory in the public site, i.e. geoblacklight.org/docs/metadata
This is the published branch containing the HTML code for the site. (We do not edit this branch directly).
index.html
: an HTML file containing the information in the index.md
file in your Main branchindex.html
/images
and /stylesheets
: same as the Main branch/assets
: contains subdirectories for /images
, /javascripts
, and /stylesheets
. These subdirectories contain the favicon and compiled code..nojekyll
: The existence of this file tells GitHub that the site is not using Jekyll. Related GitHub blog post.Everyone is welcome to contribute to the GeoBlacklight website and our documentation pages. See our Contribution Guide for detailed information about how to contribute.