logo

Contribute to the website

The DigitalCrust website is a repository that contains both code for rendering the web page and the page content.

Pages are written in Markdown with "wiki links" to navigate between pages. This link structure can be navigated as a graph using the Obsidian app or the Foam extension for VS Code.

You will need to use Git and GitHub to contribute. But contributing to this repository is a great way to learn by doing about collaborative development and version-control!

Contributing media (images, videos, etc.) is a bit more complicated. It must be uploaded to a S3 bucket and linked in pages. Instructions for this are coming soon.

Using Obsidian

Obsidian is a flexible notetaking app with persistent links and visualization tools, which works great for consistent editing across website pages. To use it for your contributions to the website, you'll need to:

  • Install and set up GitHub Desktop or the git version control tool.
  • Clone the website repository to your computer
  • Open the content directory (LocalPath.....\GitHub\digitalcrust-website\content) in Obsidian as a "vault" from an existing folder
  • Make edits to the website content directly in Obsidian and commit them to the repository through GitHub Desktop or git
  • Enjoy participating in an open collaboration to build the geoscience community's informatics capacity!