Skip to content

How to submit to the Showcase:


To add your instance of GeoBlacklight to the Showcase, you will need the following:

  • title
  • thumbnail image
  • description
  • site link
  • code repository link, such as GitHub (optional)

Option A: Ask a GeoBlacklight community member to edit this site

  1. Create a new issue on GitHub here.
  2. Include the title, description and GeoBlacklight site link in the body of the issue
  3. Upload an image to the issue that shows your homepage
  4. Include the label "showcase"
  5. Someone from the community will pick up the issue and add your instance to this site. It may be helpful to make a comment in Slack to make sure we are aware of the request.

Option B: Update files and create a pull request in GitHub ("DIY" option)

  1. Follow the instructions in the GitHub readme file on how to install mkdocs and clone this site to your desktop:
  2. Make a new branch.
  3. Navigate to this folder: docs/showcase/.
  4. Add your image to the showcase folder (jpg or png).
  5. Open docs/showcase/
  6. Create a new entry by copying and pasting the following template into the file.


    • There is a copy button at the top right of the code block.
    • Click on the text "example" to see an sample entry.
    :octicons-link-external-16: https://LINK-TO-YOUR-SITE
    -   ![](btaa-geoportal.png)
    #### [Big Ten Academic Alliance Geoportal](
    The Big Ten Academic Alliance Geoportal aggregates metadata from 14 institutions providing a single place to find and use aerial imagery, geospatial data, and scanned maps from multiple GIS data clearinghouses and library catalogs.
  7. Replace all of the placeholder text and values with your own. (The text you need to replace in the template is in ALL CAPS so that you can differentiate it. Don't use ALL CAPS for your own text.)

  8. Alphabetize your entry by title so that it appears on the Showcase page in a predicatable location.
  9. Preview your changes locally with the mkdocs serve command (see the readme for instructions).
  10. Commit your changes to the GitHub branch.
  11. Publish your branch.
  12. Open a pull request to the Main branch.
  13. Someone from the community will review and/or merge your submission.