PhotoPrism Documentation

This repository contains the source files of PhotoPrism's documentation in markdown.

They are meant to be parsed with the Mkdocs documentation builder to build the HTML documentation on docs.photoprism.org.

Contributing changes

Pull Requests should use the master branch by default.

Though arguably less convenient to edit than a wiki, this git repository is meant to receive pull requests to always improve the documentation, add new pages, etc. Having direct access to the source files in a revision control system is a big plus to ensure the quality of our documentation.

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    ...       # Other markdown pages, images and other files.

Building with Mkdocs

First make sure you have Docker and common development tools like make installed on your computer.

Then use this command in the main project directory to download and run the latest version of mkdocs-material:

make pull watch

Now open http://localhost:8000/ in a Web browser to browse the docs.

Editing existing pages

The top of every documentation page includes an 'Edit this page' link to the equivalent page on GitHub, where you can make edits (and submit Pull Requests in a few clicks) without needing any git knowledge or to run anything on your system.

To make more extensive changes, modify corresponding .md source files (or create new ones), commit the changes, push them to your fork and submit a pull request.

Other repositories on GitHub

photoprism - main source code repository
photoprism.github.io - public homepage hosted by GitHub Pages on photoprism.org

License

All the content of this repository is licensed under the Attribution-ShareAlike 4.0 International license (CC BY-SA 4.0).

tkyocum/photoprism-docs