Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions .nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Bypass Jekyll build on GitHub Pages
6 changes: 0 additions & 6 deletions 404.md

This file was deleted.

5 changes: 0 additions & 5 deletions Gemfile

This file was deleted.

223 changes: 0 additions & 223 deletions Gemfile.lock

This file was deleted.

56 changes: 36 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,47 @@
## How to contribute to the documentation - Create a Pull request
# GraphWalker Website & Documentation

1) Fork this project
This repository contains the GraphWalker website and documentation. The pre-built static site is in the `_site/` directory.

2) Clone the forked project
## Serving the Site Locally

3) In the root of the folder of the cloned project, run following command:
### Option 1: NixOS/Flakes Setup (Recommended)

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

4) Then start a local preview of the site:
1. Enter the dev shell:
```sh
nix flake update
nix develop
```

```sh
jekyll serve
```
2. Inside the shell, serve the site using Python or Node:
```sh
# Option A: Python HTTP server
python3 -m http.server 8000
```
or
```sh
# Option B: Node http-server
npx http-server -p 8000
```

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

5) Do all your changes. The site uses the Jekyll Documentation Theme. See appendix below.
### Option 2: Manual Setup (Linux, macOS, Windows)

6) Commit and push
To serve the site without Nix, use any HTTP server pointing to the `_site/` directory:

7) From your fork on GitHub, create a new pull request
```sh
# Using Python
cd _site/
python3 -m http.server 8000
```

or

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

* [Jekyll](https://jekyllrb.com/)
* [Jekyll on GitHub Pages](https://jekyllrb.com/docs/github-pages/)
* [Setting up your GitHub Pages site locally with Jekyll](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/)
* [Jekyll Documentation Theme](http://idratherbewriting.com/documentation-theme-jekyll/)
* [Pull Request Tutorial](https://yangsu.github.io/pull-request-tutorial/)
90 changes: 0 additions & 90 deletions _config.yml

This file was deleted.

Loading