2021-03-25 20:53:59 -05:00
2021-04-06 10:19:44 +02:00
2020-06-05 14:35:45 -05:00
2019-12-28 11:21:30 -05:00

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.

Languages
Haskell 67.3%
PLpgSQL 21.5%
Python 6.7%
Nix 4.3%
Shell 0.2%