-
-
Notifications
You must be signed in to change notification settings - Fork 5.9k
[website] file rendering through external binaries #5387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
techknowlogick
merged 3 commits into
go-gitea:master
from
juanpablo-santos:doc/external-renderers
Nov 23, 2018
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 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: | ||
|
||
``` | ||
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 | ||
``` | ||
|
||
## `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 | ||
``` | ||
|
||
Once your configuration changes have been made, restart Gitea to have changes take effect. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.