https://github.com/stashapp/stash-docs

The documentation maintained by the community for Stash
https://github.com/stashapp/stash-docs

documentation go golang graphql hacktoberfest json media organize organizer porn ruby scss static-site video

Last synced: 6 days ago
JSON representation

The documentation maintained by the community for Stash

• Host: GitHub
• URL: https://github.com/stashapp/stash-docs
• Owner: stashapp
• License: agpl-3.0
• Created: 2022-12-01T02:07:59.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T17:29:12.000Z (about 1 month ago)
• Last Synced: 2024-10-29T21:05:38.064Z (18 days ago)
• Topics: documentation, go, golang, graphql, hacktoberfest, json, media, organize, organizer, porn, ruby, scss, static-site, video
• Language: SCSS
• Homepage: https://docs.stashapp.cc
• Size: 29.3 MB
• Stars: 20
• Watchers: 2
• Forks: 46
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

        
# 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](CONTRIBUTING.md).

# Running locally with Ruby

## Prerequsites

- [Ruby](https://www.ruby-lang.org/en/downloads/) v2.5.0 or higher, including all development headers (check your Ruby version using `ruby -v`)

- [RubyGems](https://rubygems.org/pages/download) (check your Gems version using `gem -v`)

- [Bundler gem](https://rubygems.org/gems/bundler) 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.