diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..3a87628 --- /dev/null +++ b/.nojekyll @@ -0,0 +1 @@ +# Bypass Jekyll build on GitHub Pages diff --git a/404.md b/404.md deleted file mode 100644 index 0fb82f8..0000000 --- a/404.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Page Not Found" -search: exclude ---- - -Sorry, but the page you were trying to view does not exist — perhaps you can try searching for it. diff --git a/Gemfile b/Gemfile deleted file mode 100644 index bf4e6d9..0000000 --- a/Gemfile +++ /dev/null @@ -1,5 +0,0 @@ -source "https://rubygems.org" - -# gem "rails" -gem 'github-pages' -gem 'jekyll' \ No newline at end of file diff --git a/Gemfile.lock b/Gemfile.lock deleted file mode 100644 index 8556f68..0000000 --- a/Gemfile.lock +++ /dev/null @@ -1,223 +0,0 @@ -GEM - remote: https://rubygems.org/ - specs: - activesupport (4.2.9) - i18n (~> 0.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) - addressable (2.5.2) - public_suffix (>= 2.0.2, < 4.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.11.1) - colorator (1.1.0) - ethon (0.10.1) - ffi (>= 1.3.0) - execjs (2.7.0) - faraday (0.13.1) - multipart-post (>= 1.2, < 3) - ffi (1.9.18) - ffi (1.9.18-x86-mingw32) - forwardable-extended (2.6.0) - gemoji (3.0.0) - github-pages (163) - activesupport (= 4.2.9) - github-pages-health-check (= 1.3.5) - jekyll (= 3.5.2) - jekyll-avatar (= 0.5.0) - jekyll-coffeescript (= 1.0.2) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.9.2) - jekyll-gist (= 1.4.1) - jekyll-github-metadata (= 2.9.3) - jekyll-mentions (= 1.2.0) - jekyll-optional-front-matter (= 0.2.0) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.1.0) - jekyll-redirect-from (= 0.12.1) - jekyll-relative-links (= 0.5.0) - jekyll-sass-converter (= 1.5.0) - jekyll-seo-tag (= 2.3.0) - jekyll-sitemap (= 1.1.1) - jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.0) - jekyll-theme-cayman (= 0.1.0) - jekyll-theme-dinky (= 0.1.0) - jekyll-theme-hacker (= 0.1.0) - jekyll-theme-leap-day (= 0.1.0) - jekyll-theme-merlot (= 0.1.0) - jekyll-theme-midnight (= 0.1.0) - jekyll-theme-minimal (= 0.1.0) - jekyll-theme-modernist (= 0.1.0) - jekyll-theme-primer (= 0.5.2) - jekyll-theme-slate (= 0.1.0) - jekyll-theme-tactile (= 0.1.0) - jekyll-theme-time-machine (= 0.1.0) - jekyll-titles-from-headings (= 0.4.0) - jemoji (= 0.8.1) - kramdown (= 1.13.2) - liquid (= 4.0.0) - listen (= 3.0.6) - mercenary (~> 0.3) - minima (= 2.1.1) - rouge (= 1.11.1) - terminal-table (~> 1.4) - github-pages-health-check (1.3.5) - addressable (~> 2.3) - net-dns (~> 0.8) - octokit (~> 4.0) - public_suffix (~> 2.0) - typhoeus (~> 0.7) - html-pipeline (2.7.1) - activesupport (>= 2) - nokogiri (>= 1.4) - i18n (0.8.6) - jekyll (3.5.2) - addressable (~> 2.4) - colorator (~> 1.0) - jekyll-sass-converter (~> 1.0) - jekyll-watch (~> 1.1) - kramdown (~> 1.3) - liquid (~> 4.0) - mercenary (~> 0.3.3) - pathutil (~> 0.9) - rouge (~> 1.7) - safe_yaml (~> 1.0) - jekyll-avatar (0.5.0) - jekyll (~> 3.0) - jekyll-coffeescript (1.0.2) - coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.9.2) - jekyll (~> 3.3) - jekyll-gist (1.4.1) - octokit (~> 4.2) - jekyll-github-metadata (2.9.3) - jekyll (~> 3.1) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.2.0) - activesupport (~> 4.0) - html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-optional-front-matter (0.2.0) - jekyll (~> 3.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.1.0) - jekyll (~> 3.0) - jekyll-redirect-from (0.12.1) - jekyll (~> 3.3) - jekyll-relative-links (0.5.0) - jekyll (~> 3.3) - jekyll-sass-converter (1.5.0) - sass (~> 3.4) - jekyll-seo-tag (2.3.0) - jekyll (~> 3.3) - jekyll-sitemap (1.1.1) - jekyll (~> 3.3) - jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.2) - jekyll (~> 3.5) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.2) - jekyll-theme-slate (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.0) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.4.0) - jekyll (~> 3.3) - jekyll-watch (1.5.0) - listen (~> 3.0, < 3.1) - jemoji (0.8.1) - activesupport (~> 4.0, >= 4.2.9) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (>= 3.0) - kramdown (1.13.2) - liquid (4.0.0) - listen (3.0.6) - rb-fsevent (>= 0.9.3) - rb-inotify (>= 0.9.7) - mercenary (0.3.6) - mini_portile2 (2.3.0) - minima (2.1.1) - jekyll (~> 3.3) - minitest (5.10.3) - multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.8.1) - mini_portile2 (~> 2.3.0) - nokogiri (1.8.1-x86-mingw32) - mini_portile2 (~> 2.3.0) - octokit (4.7.0) - sawyer (~> 0.8.0, >= 0.5.3) - pathutil (0.14.0) - forwardable-extended (~> 2.6) - public_suffix (2.0.5) - rb-fsevent (0.10.2) - rb-inotify (0.9.10) - ffi (>= 0.5.0, < 2) - rouge (1.11.1) - safe_yaml (1.0.4) - sass (3.5.2) - sass-listen (~> 4.0.0) - sass-listen (4.0.0) - rb-fsevent (~> 0.9, >= 0.9.4) - rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.1) - addressable (>= 2.3.5, < 2.6) - faraday (~> 0.8, < 1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) - thread_safe (0.3.6) - typhoeus (0.8.0) - ethon (>= 0.8.0) - tzinfo (1.2.3) - thread_safe (~> 0.1) - unicode-display_width (1.3.0) - -PLATFORMS - ruby - x86-mingw32 - -DEPENDENCIES - github-pages - jekyll - -BUNDLED WITH - 1.15.3 diff --git a/README.md b/README.md index 309b6d2..17ae56d 100644 --- a/README.md +++ b/README.md @@ -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/) diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 355ac54..0000000 --- a/_config.yml +++ /dev/null @@ -1,90 +0,0 @@ -permalink: /:year/:month/:day/:title/ -# this sets the style for permalinks. The date formatting (/:year/:month/:day/) will only apply to blog posts, while the pages will just show the title. -url: http://graphwalker.org -# where you plan to publish your site -baseurl: -# any subdirectory that appears after the domain where you're publishing your site -output: web -# this property is useful for conditional filtering of content that is separate from the PDF. -topnav_title: GraphWalker -# this appears on the top navigation bar next to the home button -site_title: GraphWalker for testers -# this appears in the html browser tab for the site title (seen mostly by search engines, not users) -company_name: graphwalker.org -# this appears in the footer -google_analytics: UA-67286726-1 -# google analytics tracker -github_editme_path: -# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. -disqus_shortname: GraphWalker -# if you're using disqus for comments, add the shortname here. if not, leave this value blank. -host: 127.0.0.1 -# the preview server used. Leave as is. -port: 4005 -# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. - -exclude: - - _site - - _drafts/ - - .idea/ -# these are the files and directories that jekyll will exclude from the build - -feedback_email: graphwalker-3@googlegroups.com -# used as a contact email for the Feedback link in the top navigation bar - -#feedback_disable: true -#feedback_text: "Need help?" -#feedback_link: "http://helpy.io/" -# change feedback link behaviour if you use a support ticketing system or something else - -highlighter: rouge -# library used for syntax highlighting - -markdown: kramdown -kramdown: - input: GFM - auto_ids: true - hard_wrap: false - syntax_highlighter: rouge -# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways - -collections: - tooltips: - output: false -# collection declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output. - -defaults: - - - scope: - path: "" - type: "pages" - values: - layout: "page" - comments: true - search: true - sidebar: home_sidebar - - - scope: - path: "" - type: "tooltips" - values: - layout: "page" - comments: true - search: true - tooltip: true - - - - scope: - path: "" - type: "posts" - values: - layout: "post" - comments: true - search: true - sidebar: tags_sidebar - -# these are defaults used for the frontmatter for these file types - - -description: "GraphWalker is a Model-Based testing tool built in Java. It reads models in the shape of finite-state diagrams, or directed graphs, and generate tests from the models, either offline or online." -# the description is used in the feed.xml file diff --git a/_data/alerts.yml b/_data/alerts.yml deleted file mode 100644 index 157e162..0000000 --- a/_data/alerts.yml +++ /dev/null @@ -1,15 +0,0 @@ -tip: '