From 02062be4c4419a07d5b4f648c3196b97ae23564d Mon Sep 17 00:00:00 2001 From: Rami Date: Sat, 27 Feb 2021 22:15:45 -0800 Subject: [PATCH] Using just-the-docs remote theme for github pages --- docs/.gitignore | 5 + docs/Documentation.md | 19 --- docs/Gemfile | 25 ++++ docs/Gemfile.lock | 271 ++++++++++++++++++++++++++++++++++++++++ docs/_Sidebar.md | 24 ---- docs/_config.yml | 21 +++- docs/_data/nav.yml | 45 +++++++ docs/_includes/nav.html | 16 +++ docs/index.md | 27 +--- 9 files changed, 383 insertions(+), 70 deletions(-) create mode 100644 docs/.gitignore delete mode 100644 docs/Documentation.md create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock delete mode 100644 docs/_Sidebar.md create mode 100644 docs/_data/nav.yml create mode 100644 docs/_includes/nav.html diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..f40fbd8 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor diff --git a/docs/Documentation.md b/docs/Documentation.md deleted file mode 100644 index e7c5f19..0000000 --- a/docs/Documentation.md +++ /dev/null @@ -1,19 +0,0 @@ -### Initial Setup -* [Getting Started With SpecBind](Getting-Started-With-SpecBind.md) -* [Configuration](Configuration.md) -* [Debugging](Debugging.md) - -### Understanding Available Steps -* [Navigation Steps](Navigation-Steps.md) -* [Waiting Steps](Waiting-Steps.md) -* [Entering Data Steps](Entering-Data-Steps.md) -* [Clicking Items Steps](Clicking-Items-Steps.md) -* [Verifying Steps](Verifying-Steps.md) -* [Using Tokens](Using-Tokens.md) - -### Developing Page Binding Code -* [Page Navigation Binding](Page-Navigation-Binding.md) -* [Page Model Properties](Page-Model-Properties.md) -* [Working With Lists](Working-With-Lists.md) -* [Dialog Pages](Dialog-Pages.md) -* [Frames](Frames.md) \ No newline at end of file diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 0000000..a288b7f --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,25 @@ +source "https://rubygems.org" +# Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# + +gem "jekyll-remote-theme" + +gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" + gem "jekyll-remote-theme" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] + diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 0000000..cfa581a --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,271 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (6.0.3.5) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.8) + dnsruby (1.61.5) + simpleidn (~> 0.1) + em-websocket (0.5.2) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) + eventmachine (1.2.7-x64-mingw32) + execjs (2.7.0) + faraday (1.3.0) + faraday-net_http (~> 1.0) + multipart-post (>= 1.2, < 3) + ruby2_keywords + faraday-net_http (1.0.1) + ffi (1.14.2-x64-mingw32) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (212) + github-pages-health-check (= 1.17.0) + jekyll (= 3.9.0) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.15.1) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.2) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.7.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.2) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.12.0) + kramdown (= 2.3.0) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.26.0) + terminal-table (~> 1.4) + github-pages-health-check (1.17.0) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (>= 2.0.2, < 5.0) + typhoeus (~> 1.3) + html-pipeline (2.14.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.9.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.15.1) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.2) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.7.1) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.2) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (2.3.0) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.4.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.14.4) + multipart-post (2.1.1) + nokogiri (1.11.1-x64-mingw32) + racc (~> 1.4) + octokit (4.20.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.6) + racc (1.5.2) + rb-fsevent (0.10.4) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.4) + rouge (3.26.0) + ruby-enum (0.9.0) + i18n + ruby2_keywords (0.0.4) + rubyzip (2.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + 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.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + simpleidn (0.2.1) + unf (~> 0.1.4) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (1.2.9) + thread_safe (~> 0.1) + tzinfo-data (1.2021.1) + tzinfo (>= 1.0.0) + unf (0.1.4) + unf_ext + unf_ext (0.0.7.7-x64-mingw32) + unicode-display_width (1.7.0) + wdm (0.1.1) + zeitwerk (2.4.2) + +PLATFORMS + x64-mingw32 + +DEPENDENCIES + github-pages + jekyll-feed (~> 0.12) + jekyll-remote-theme + tzinfo (~> 1.2) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.2.11 diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md deleted file mode 100644 index 95278e8..0000000 --- a/docs/_Sidebar.md +++ /dev/null @@ -1,24 +0,0 @@ -## Table of Contents ## - -### Initial Setup -* [Getting Started With SpecBind](Getting-Started-With-SpecBind.md) -* [Configuration](Configuration.md) -* [Debugging](Debugging.md) - -### Understanding Available Steps -* [Navigation Steps](Navigation-Steps.md) -* [Waiting Steps](Waiting-Steps.md) -* [Entering Data Steps](Entering-Data-Steps.md) -* [Clicking Items Steps](Clicking-Items-Steps.md) -* [Verifying Steps](Verifying-Steps.md) -* [Using Tokens](Using-Tokens.md) - -### Developing Page Binding Code -* [Page Navigation Binding](Page-Navigation-Binding.md) -* [Page Model Properties - Coded UI](Page-Model-Properties.md) -* [Page Model Properties - Selenium](Page-Model-Properties-Selenium.md) -* [Working With Lists](Working-With-Lists.md) -* [Dialog Pages](Dialog-Pages.md) -* [Frames](Frames.md) -* [Executing JavaScript In Pages](Executing-JavaScript-In-Pages.md) -* [Custom Validation Rules](Custom-Validation-Rules.md) \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index c741881..ad34079 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1 +1,20 @@ -theme: jekyll-theme-slate \ No newline at end of file +remote_theme: pmarsceill/just-the-docs + +title: SpecBind Docs + +# Aux links for the upper right navigation +aux_links: + "SpecBind on GitHub": + - "//github.com/SpecBind/specbind" + +# Makes Aux links open in a new tab. Default is false +aux_links_new_tab: false + + +# Footer "Edit this page on GitHub" link text +gh_edit_link: true # show or hide edit this page link +gh_edit_link_text: "Edit this page on GitHub." +gh_edit_repository: "https://github.com/SpecBind/specbind" # the github URL for your repo +gh_edit_branch: "master" # the branch that your docs is served from +gh_edit_source: docs # the source that your files originate from +gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately \ No newline at end of file diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml new file mode 100644 index 0000000..7860f7d --- /dev/null +++ b/docs/_data/nav.yml @@ -0,0 +1,45 @@ +- title: "Home" + url: "/" + +- title: "Initial Setup" + items: + - title: "Getting Started With SpecBind" + url: "Getting-Started-With-SpecBind" + - title: "Configuration" + url: "Configuration" + - title: "Debugging" + url: "Debugging" + +- title: "Understanding Available Steps" + items: + - title: "Navigation Steps" + url: "Navigation-Steps" + - title: "Waiting Steps" + url: "Waiting-Steps" + - title: "Entering Data Steps" + url: "Entering-Data-Steps" + - title: "Clicking Items Steps" + url: "Clicking-Items-Steps" + - title: "Verifying Steps" + url: "Verifying-Steps" + - title: "Using Tokens" + url: "Using-Tokens" + +- title: "Developing Page Binding Code" + items: + - title: "Page Navigation Binding" + url: "Page-Navigation-Binding" + - title: "Page Model Properties - Coded UI" + url: "Page-Model-Properties" + - title: "Page Model Properties - Selenium" + url: "Page-Model-Properties-Selenium" + - title: "Working With Lists" + url: "Working-With-Lists" + - title: "Dialog Pages" + url: "Dialog-Pages" + - title: "Frames" + url: "Frames" + - title: "Executing JavaScript In Pages" + url: "Executing-JavaScript-In-Pages" + - title: "Custom Validation Rules" + url: "Custom-Validation-Rules" \ No newline at end of file diff --git a/docs/_includes/nav.html b/docs/_includes/nav.html new file mode 100644 index 0000000..5999e34 --- /dev/null +++ b/docs/_includes/nav.html @@ -0,0 +1,16 @@ + \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index dbc38a1..e52dcd1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -25,29 +25,4 @@ One of the key features of SpecBind is it features a common set of steps that ca ## Next Steps -Follow the [Getting Started](Getting-Started-With-SpecBind.md) section to begin creating tests, or [Documentation](Documentation.md) for in detailed information on SpecBind. - -## Table of Contents - -### Initial Setup -* [Getting Started With SpecBind](Getting-Started-With-SpecBind.md) -* [Configuration](Configuration.md) -* [Debugging](Debugging.md) - -### Understanding Available Steps -* [Navigation Steps](Navigation-Steps.md) -* [Waiting Steps](Waiting-Steps.md) -* [Entering Data Steps](Entering-Data-Steps.md) -* [Clicking Items Steps](Clicking-Items-Steps.md) -* [Verifying Steps](Verifying-Steps.md) -* [Using Tokens](Using-Tokens.md) - -### Developing Page Binding Code -* [Page Navigation Binding](Page-Navigation-Binding.md) -* [Page Model Properties - Coded UI](Page-Model-Properties.md) -* [Page Model Properties - Selenium](Page-Model-Properties-Selenium.md) -* [Working With Lists](Working-With-Lists.md) -* [Dialog Pages](Dialog-Pages.md) -* [Frames](Frames.md) -* [Executing JavaScript In Pages](Executing-JavaScript-In-Pages.md) -* [Custom Validation Rules](Custom-Validation-Rules.md) \ No newline at end of file +Follow the [Getting Started](Getting-Started-With-SpecBind.md) section to begin creating tests, or [Documentation](Documentation.md) for in detailed information on SpecBind. \ No newline at end of file