diff --git a/docs/building/pl-fe.md b/docs/building/pl-fe.md index 374a2676f..67c9e7103 100644 --- a/docs/building/pl-fe.md +++ b/docs/building/pl-fe.md @@ -25,6 +25,7 @@ pnpm -F pl-fe build The built files will be located in the `packages/pl-fe/dist` directory. You can [serve them using a static web server](./installing/standalone.md). Following environment variables can be used to customize the instance in build process: + - `BACKEND_URL` - URL of the Mastodon-compatible instance to connect to. If not set, tries fetching /api/v1/instance from the origin and falls back to standalone mode. - `FE_SUBDIRECTORY` - The path where pl-fe is mounted to. Defaults to `/`. - `WITH_LANDING_PAGE` - Displays the landing page on the home page, when running in standalone mode. \ No newline at end of file diff --git a/docs/installing/mitra.md b/docs/installing/mitra.md index 3800ea899..75f3e75b8 100644 --- a/docs/installing/mitra.md +++ b/docs/installing/mitra.md @@ -2,7 +2,7 @@ Installing `pl-fe` as a frontend for Mitra is no different from installing the default Mitra Web frontend. Just extract the `pl-fe` files into the directory specified in `config.yaml` under `web_client_dir`, by default `/usr/share/mitra/www`. -```sh +```bash curl -O https://pl.mkljczk.pl/pl-fe.zip unzip pl-fe.zip -d /usr/share/mitra/www rm pl-fe.zip diff --git a/docs/installing/pleroma-akkoma.md b/docs/installing/pleroma-akkoma.md index ba19fc0a0..aa80aed3e 100644 --- a/docs/installing/pleroma-akkoma.md +++ b/docs/installing/pleroma-akkoma.md @@ -4,7 +4,7 @@ The most straightforward way to install `pl-fe` as a frontend for Pleroma or Akkoma is to simply download it and place its files in the `/instance/static` directory of your Pleroma/Akkoma installation (usually `/opt/pleroma/instance/static` or `/opt/akkoma/instance/static`, accordingly). -```sh +```bash curl -O https://pl.mkljczk.pl/pl-fe.zip unzip pl-fe.zip -d /opt/pleroma/instance/static/ rm pl-fe.zip @@ -17,13 +17,13 @@ It is also possible to use the Pleroma frontend management tool. You can find mo On Akkoma, however, there is no `pl-fe` in the default available frontends list ([yet?](https://akkoma.dev/AkkomaGang/akkoma/pulls/945)). You can still install it, but you need to explicitly provide the URL to `pl-fe`. To install it from CLI, use: ### OTP -```sh +```bash ./bin/pleroma_ctl frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir . ``` ### From Source -```sh +```bash mix pleroma.frontend install pl-fe --ref develop --build-url https://pl.mkljczk.pl/pl-fe.zip --build-dir . ``` diff --git a/mkdocs.yml b/mkdocs.yml index be0cf9a4c..e77d78b61 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,6 +19,12 @@ plugins: - search: lang: en - include-markdown - markdown_extensions: - admonition + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences