Initial version

.github/workflows/jekyll.yml

@@ -0,0 +1,50 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -0,0 +1,5 @@
+# ignore directories for local testing
+.jekyll-cache/
+_site/
+.vscode
+cheatsheet.md

Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+gem "webrick", "~> 1.7"
+gem "just-the-docs"
+
+group :jekyll_plugins do
+    gem "jekyll-remote-theme", "~> 0.4.2"
+  end

Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5-x64-mingw-ucrt)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-remote-theme (0.4.3)
+      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 (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    just-the-docs (0.3.3)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    rubyzip (2.3.2)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+
+PLATFORMS
+  x64-mingw-ucrt
+
+DEPENDENCIES
+  jekyll-remote-theme (~> 0.4.2)
+  just-the-docs
+  webrick (~> 1.7)
+
+BUNDLED WITH
+   2.3.21

README.md

@@ -0,0 +1,2 @@
+# Stash-Docs (work-in-progress)
+Website: https://dogmadragon.github.io/Stash-Docs/

_config.yml

@@ -0,0 +1,65 @@
+remote_theme: just-the-docs/just-the-docs
+plugins:
+  - jekyll-remote-theme
+exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json",  "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
+
+title: Stash-Docs
+description: Documentation for Stash software
+domain: dogmadragon.github.io
+url: "https://dogmadragon.github.io/"
+baseurl: "/Stash-Docs"
+
+permalink: pretty
+
+# Set a path/url to a logo that will be displayed instead of the title
+logo: "/assets/logo_v2.png"
+#logo: https://stashapp.cc/images/stash.svg
+
+# Aux links for the upper right navigation
+aux_links:
+  "Donate @ Open Collective":
+    - "https://opencollective.com/stashapp"
+aux_links_new_tab: true
+
+# External navigation links
+nav_external_links:
+  - title: Community Discord
+    url: https://discord.gg/frQ7qBvB3S
+
+# Footer content
+# appears at the bottom of every page's main content
+
+# 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/DogmaDragon/Stash-Docs" # the github URL for your repo
+gh_edit_branch: "master" # the branch that your docs is served from
+gh_edit_view_mode: "edit" # "tree" or "edit" if you want the user to jump into the editor immediately
+
+# Back to top link
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: "Maintained by Stash community"
+
+# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
+color_scheme: stashdb-dark
+
+callouts:
+  warning:
+    title: Warning
+    color: red
+  note:
+    title: Note
+    color: yellow 
+  new:
+    title: New
+    color: green
+  important:
+    title: Important
+    color: blue 
+
+kramdown:
+  syntax_highlighter_opts:
+    block:
+      line_numbers: false

_sass/color_schemes/stashdb-dark.scss

@@ -0,0 +1,21 @@
+$link-color: #48aff0;
+$btn-primary-color: #48aff0;
+$base-button-color: $grey-dk-250;
+$sidebar-color: #394B59;
+$body-background-color: #202B33;
+$body-text-color: #FFFFFF;
+$body-heading-color: #F5F8FA;
+$nav-child-link-color: #E9ECEF;
+$border-color: #808080;
+$table-background-color: $grey-dk-250;
+$feedback-color: darken($sidebar-color, 3%);
+$search-result-preview-color: $grey-dk-000;
+$search-background-color: $grey-dk-250;
+@import "./vendor/OneDarkJekyll/syntax-one-dark-vivid";
+$code-background-color: #394B59;
+.highlight, pre.highlight {
+    background-color: #394B59 !important;
+}
+th, td {
+    background-color: #394B59 !important;
+}

_sass/color_schemes/stashdb-light.scss

@@ -0,0 +1,4 @@
+$link-color: #137CBD;
+$btn-primary-color: #137CBD;
+$sidebar-color: #E9ECEF;
+$body-text-color: #000000;

_sass/custom/custom.scss

@@ -0,0 +1,19 @@
+@media (min-width: 50rem) { .site-title { padding-right: 0rem; padding-left: 2rem; } }
+
+@media (min-width: 66.5rem) { .side-bar {
+    width: calc((100% - 1064px) / 2 + 264px);
+    min-width: 264px;
+    max-width: fit-content;
+} }
+
+@media (min-width: 66.5rem) {
+.main {
+    margin-left: calc( (100% - 100% + 2px) / 2 + 264px );
+    max-width: -webkit-fill-available;
+	} }
+
+@media (min-width: 50rem) {
+.main-content-wrap {
+    padding-right: 4rem;
+    padding-left: 4rem;
+	} }

docs/Add-ons.md

@@ -0,0 +1,24 @@
+---
+layout: default
+title: Add-ons
+nav_order: 5
+has_children: true
+has_toc: false
+---
+# **Add-ons**
+{: .no_toc }
+
+---
+
+<details open markdown="block">
+  <summary>
+    Table of Contents
+  </summary>
+  {: .text-delta }
+1. [Scrapers]({{ site.baseurl }}/docs/Add-ons/Scrapers/)
+2. [Plugins]({{ site.baseurl }}/docs/Add-ons/Plugins/)
+3. [Scripts]({{ site.baseurl }}/docs/Add-ons/Scripts/)
+4. [Userscripts]({{ site.baseurl }}/docs/Add-ons/Userscripts/)
+5. [Utilities]({{ site.baseurl }}/docs/Add-ons/Utilities/)
+6. [Third-Party Integrations]({{ site.baseurl }}/docs/Add-ons/Third-Party-Integrations/)
+</details>