This repository contains the source code for the "Adventures in Deep Space" website, hosted on GitHub Pages. It uses Jekyll and Liquid to render Markdown and HTML into a static site.
docs/: Contains the primary website source code, including_config.ymland content files (.md,.htm,.html).docs/assets/: Stores images and other BLOB assets.- Note: Please be mindful of the size of this directory. Ensure assets are optimized and avoid adding excessively large files to maintain repository health.
scripts/: Contains Python and shell scripts for data processing, maintenance, and site generation.pyproject.toml/uv.lock: Configuration for the Python environment and dependencies.
To run the website locally for testing and development, follow these steps:
- Ruby (refer to
docs/Gemfilefor versioning) - Bundler (
gem install bundler) - Jekyll
- Navigate to the
docs/directory:cd docs - Install dependencies:
bundle install
- Start the Jekyll server:
bundle exec jekyll serve - Once the server is running, navigate your browser to:
http://localhost:4000
The repository includes a suite of scripts in scripts/ to manage DSO (Deep Sky Object) data, ingest emails, and fix formatting.
- Python Version: 3.13 (managed via
.python-version) - Dependency Management: Use
uvorpipto manage dependencies listed inpyproject.tomlorscripts/requirements.txt.
# Example: Install dependencies using uv
uv sync