/Stash-Docs

The documentation maintained by the community for Stash

Primary LanguageSCSSGNU Affero General Public License v3.0AGPL-3.0

Stash-Docs

Website: https://docs.stashapp.cc

Contributing

Everyone is welcome to help with the documentation. All changes are managed through pull requests.

Read step-by-step guide on how to create a pull request CONTRIBUTING.md.

Running locally with Ruby

Prerequsites

  • Ruby v2.5.0 or higher, including all development headers (check your Ruby version using ruby -v)
  • RubyGems (check your Gems version using gem -v)
  • Bundler gem run gem install bundler
  • Clone/download the repository

Building the site

  1. Open Terminal/Command Prompt with Ruby and go to your directory where you saved the copy of the repository
  2. Run bundle exec jekyll serve

You can add --livereload option to automatically refresh the page after changes.