Skip to content
This repository has been archived by the owner on Feb 24, 2024. It is now read-only.

Commit

Permalink
chore: Add note about repo status to README
Browse files Browse the repository at this point in the history
  • Loading branch information
wolfgangwalther committed Feb 24, 2024
1 parent 1b855d8 commit 72904ef
Showing 1 changed file with 1 addition and 38 deletions.
39 changes: 1 addition & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1 @@
# PostgREST documentation https://postgrest.org/

PostgREST docs use the reStructuredText format, check this [cheatsheet](https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst) to get acquainted with it.

To build the docs locally, use [nix](https://nixos.org/nix/):

```bash
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.

## Translating

To create `.po` files for translation into a new language pass the language code as the first argument to `postgrest-docs-build`.

Example to add German/de:

```
postgrest-docs-build de
```

The livereload server also supports a language/locale argument to show the translated docs during translation:

```
postgrest-docs-serve de
```

Spellcheck is currently only available for the default language.
This repo has been moved into the core repo at https://github.com/PostgREST/postgrest/tree/main/docs.

0 comments on commit 72904ef

Please sign in to comment.