Skip to content

Documentation for the Maintainerr software.

Notifications You must be signed in to change notification settings

ydkmlt84/Maintainerr_docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Maintainerr's docs image

Discord GitHub Issues or Pull Requests Static Badge Doc changes updated

Maintainerr makes managing your media easy.

  • Do you hate being the janitor of your server?
  • Do you have a lot of media that never gets watched?
  • Do your users constantly request media, and let it sit there afterward never to be touched again?

If you answered yes to any of those questions.. You NEED Maintainerr. It's a one-stop-shop for handling those outlying shows and movies that take up precious space on your server.

This repo exists solely for the documentation of Maintainerr.

The "Docs"

  • These docs are made using the lovely Material for MkDocs project.

  • Roughly 95% percent of the documentation is written using the markdown syntax.

  • There is a ton of documentation out there for markdown but this one is my favorite. -> MarkdownGuide.

Contributing

The docs website itself runs on a Material for Mkdocs docker container, and is self hosted. It also uses the Insiders edition of the previously mentioned project.

If you would like to add anything to the docs, especially a guide/tutorial, please feel free to make a PR on Github. You can see the structure of the site in the repo directory.

There are a TON of options in the Material for Mkdocs project, and they are outlined here -> Getting Started. If you want to include something that is an insiders only option, you can do that and I will take a look on my end. You will have to purchase it though, if you want to test it before pushing your PR.

Credits

I have personally added and tweaked some things here, but thanks goes out the Maintainerr dev who made the wise decision to document his work. Please check out Maintainerr, and if you love it, consider donating with the KOFI link at the top of this README.

About

Documentation for the Maintainerr software.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •