Skip to content

README.md

Latest commit

 

History

History
90 lines (66 loc) · 2.29 KB

README.md

File metadata and controls

90 lines (66 loc) · 2.29 KB

GraphWalker Website & Documentation

This repository contains the GraphWalker website and documentation. The pre-built static site is in the _site/ directory.

Serving the Site Locally

Option 1: NixOS/Flakes Setup (Recommended)

If you're on NixOS or have Nix installed, use the provided flake.nix for a reproducible dev environment:

  1. Enter the dev shell:

    nix flake update
nix develop

  2. Inside the shell, serve the site using Python or Node:

    # Option A: Python HTTP server
python3 -m http.server 8000

    or

    # Option B: Node http-server
npx http-server -p 8000

  3. Open your browser to http://localhost:8000 to preview the site.

Option 2: Manual Setup (Linux, macOS, Windows)

To serve the site without Nix, use any HTTP server pointing to the _site/ directory:

# Using Python
cd _site/
python3 -m http.server 8000

or

# Using Node (install http-server globally first: npm install -g http-server)
cd _site/
http-server -p 8000

Contributing

Making Changes

  1. Fork this repository.

  2. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/graphwalker.github.io.git
cd graphwalker.github.io

  3. Create a new branch for your changes:

    git checkout -b feature/your-feature-name

  4. Make your changes to the documentation in the docs/ directory. The site uses the Jekyll Documentation Theme (see Resources below).

  5. Build the site (regenerate _site/):

    jekyll build

  6. Test your changes locally by serving the site (see "Serving the Site Locally" above).

  7. Commit and push:

    git add .
git commit -m "Describe your changes"
git push origin feature/your-feature-name

  8. Create a Pull Request on GitHub from your fork to the main repository.

Resources & References