From cdd6cb904f9a982bba31ab75fdf75be64ee67d49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20Santos=20Rodr=C3=ADguez?= Date: Fri, 23 Nov 2018 09:53:20 +0000 Subject: [PATCH 1/3] #3758: [doc] file rendering through external binaries --- .../doc/advanced/external-renderers.en-us.md | 70 +++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs/content/doc/advanced/external-renderers.en-us.md diff --git a/docs/content/doc/advanced/external-renderers.en-us.md b/docs/content/doc/advanced/external-renderers.en-us.md new file mode 100644 index 0000000000000..cbd4095cdcbfa --- /dev/null +++ b/docs/content/doc/advanced/external-renderers.en-us.md @@ -0,0 +1,70 @@ +--- +date: "2018-11-23:00:00+02:00" +title: "External renderers" +slug: "external-renderers" +weight: 40 +toc: true +draft: false +menu: + sidebar: + parent: "advanced" + name: "External renderers" + weight: 40 + identifier: "external-renderers" +--- + +# Custom files rendering configuration + +Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries, +it is just matter of: +* installing external binaries +* add configuration to your `app.ini` file +* restart your gitea instance + +**1.- Installing external binaries** +In order to get file rendering through external binaries, their associated packages must be installed. +If you're using a Docker image, your Dockerfile should contain something along this lines: + +``` +FROM gitea/gitea:1.6.0 +[...] + +COPY custom/app.ini /data/gitea/conf/app.ini +[...] + +RUN apk --no-cache add asciidoctor freetype freetype-dev gcc g++ libpng python-dev py-pip python3-dev py3-pip +# install any other package you need for your external renderers + +RUN pip3 install --upgrade pip +RUN pip3 install -U setuptools +RUN pip3 install jupyter matplotlib docutils +# add above any other python package you may need to install +``` + +**2.- `app.ini` file configuration** + +add one `[markup.XXXXX]` section per external renderer on your custom `app.ini`: + +``` +[markup.asciidoc] +ENABLED = true +FILE_EXTENSIONS = .adoc,.asciidoc +RENDER_COMMAND = "asciidoctor --out-file=- -" +; Input is not a standard input but a file +IS_INPUT_FILE = false + +[markup.jupyter] +ENABLED = true +FILE_EXTENSIONS = .ipynb +RENDER_COMMAND = "jupyter nbconvert --stdout --to html --template basic " +IS_INPUT_FILE = true + +[markup.restructuredtext] +ENABLED = true +FILE_EXTENSIONS = .rst +RENDER_COMMAND = rst2html.py +IS_INPUT_FILE = false +``` + +**3.- restart your gitea instance** +profit! From d2870ac3c450fedb364b8557f2e2ca4afafcfc61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20Santos=20Rodr=C3=ADguez?= Date: Fri, 23 Nov 2018 09:58:04 +0000 Subject: [PATCH 2/3] fix subsections markup --- docs/content/doc/advanced/external-renderers.en-us.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/content/doc/advanced/external-renderers.en-us.md b/docs/content/doc/advanced/external-renderers.en-us.md index cbd4095cdcbfa..2876dc46bacce 100644 --- a/docs/content/doc/advanced/external-renderers.en-us.md +++ b/docs/content/doc/advanced/external-renderers.en-us.md @@ -21,7 +21,7 @@ it is just matter of: * add configuration to your `app.ini` file * restart your gitea instance -**1.- Installing external binaries** +## Installing external binaries In order to get file rendering through external binaries, their associated packages must be installed. If you're using a Docker image, your Dockerfile should contain something along this lines: @@ -41,7 +41,7 @@ RUN pip3 install jupyter matplotlib docutils # add above any other python package you may need to install ``` -**2.- `app.ini` file configuration** +## `app.ini` file configuration add one `[markup.XXXXX]` section per external renderer on your custom `app.ini`: @@ -65,6 +65,5 @@ FILE_EXTENSIONS = .rst RENDER_COMMAND = rst2html.py IS_INPUT_FILE = false ``` - -**3.- restart your gitea instance** +## restart your gitea instance profit! From 1a79b108fdee2e4d38b1c91506c23861805a638e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20Santos=20Rodr=C3=ADguez?= Date: Fri, 23 Nov 2018 14:56:37 +0000 Subject: [PATCH 3/3] include proposed changes from PR review --- docs/content/doc/advanced/external-renderers.en-us.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/content/doc/advanced/external-renderers.en-us.md b/docs/content/doc/advanced/external-renderers.en-us.md index 2876dc46bacce..52374bc01d301 100644 --- a/docs/content/doc/advanced/external-renderers.en-us.md +++ b/docs/content/doc/advanced/external-renderers.en-us.md @@ -18,12 +18,13 @@ menu: Gitea supports custom file renderings (i.e., Jupyter notebooks, asciidoc, etc.) through external binaries, it is just matter of: * installing external binaries -* add configuration to your `app.ini` file +* add some configuration to your `app.ini` file * restart your gitea instance ## Installing external binaries + In order to get file rendering through external binaries, their associated packages must be installed. -If you're using a Docker image, your Dockerfile should contain something along this lines: +If you're using a Docker image, your `Dockerfile` should contain something along this lines: ``` FROM gitea/gitea:1.6.0 @@ -65,5 +66,5 @@ FILE_EXTENSIONS = .rst RENDER_COMMAND = rst2html.py IS_INPUT_FILE = false ``` -## restart your gitea instance -profit! + +Once your configuration changes have been made, restart Gitea to have changes take effect.