forgejo-asciidoc/README.adoc

41 lines
1.5 KiB
Plaintext
Raw Normal View History

2022-12-17 15:08:35 +02:00
= Forgejo with AsciiDoc support
2022-06-11 15:10:57 +03:00
2022-12-17 15:08:35 +02:00
The official Forgejo Docker image does not support AsciiDoc rendering, so I
2022-06-09 19:37:48 +03:00
wanted to create an image which has support out of the box.
2022-12-17 15:08:35 +02:00
== Pull from my Forgejo instance
2022-12-17 15:18:36 +02:00
Visit the link:/FunctionalHacker/forgejo-asciidoc/packages[Packages section] for more information.
2022-12-17 17:27:52 +02:00
The server is running behind 4G broadband so it might be a bit slow to download. Consider pulling
2022-12-17 17:45:50 +02:00
the other layers first from link:https://forgejo.org/download[the official image] to
speed up the download.
2022-06-09 20:13:10 +03:00
2022-06-09 19:37:48 +03:00
== Configuration
In addition to pulling this image instead of the official one, you need to
configure the renderer. You can follow the
https://docs.gitea.io/en-us/external-renderers/#appini-file-configuration[official docs]
to achieve that.
.My configuration on this Forgejo instance
[%collapsible]
====
[source,ini]
----
[markup.asciidoc]
ENABLED = true
FILE_EXTENSIONS = .adoc,.asciidoc
RENDER_COMMAND = "asciidoctor -s -a skip-front-matter -a showtitle -a source-highlighter=rouge --out-file=- -"
IS_INPUT_FILE = false
----
====
2022-06-09 19:37:48 +03:00
== Updates
2022-12-17 15:08:35 +02:00
This image is based on the latest official Forgejo image.
I will update it whenever I notice the Forgejo team update their image and
2022-06-09 19:37:48 +03:00
I have the time to do it.
== Support
This image comes with no support whatsoever. The Dockerfile is based on the
2022-12-17 15:08:35 +02:00
official Forgejo image and it is literally 2 lines long so there is not much to go wrong here.
2022-06-09 19:37:48 +03:00
If, for whatever reason you feel that there must be something wrong with my image, you
2022-12-17 15:08:35 +02:00
can email me at mailto:forgejo@functionalhacker.korhonen.cc[forgejo@functionalhacker.korhonen.cc]