PostgREST documentation http://postgrest.org/

PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.

To build the docs locally, use nix:

  nix-shell

Once in the nix-shell you have the following commands available:

• postgrest-docs-build: Build the docs.
• postgrest-docs-serve: Build the docs and start a livereload server on http://localhost:5500.
• postgrest-docs-spellcheck: Run aspell.

Documentation structure

This documentation is structured according to tutorials-howtos-topics-references. For more details on the rationale of this structure, see https://www.divio.com/blog/documentation.

Translations

Translations are maintained in separate repositories forked from this one. Once you finish translating in your fork you can upload the project to https://readthedocs.org and we'll link to it in the official documentation site https://postgrest.org.

See more details in the chinese translation PR.

Available translations

• Chinese - https://github.com/Lellansin/postgrest-docs (latest version v0.4.2.0)