Asciidoctor :: Discussion

Apache plugin to render .adoc on server side?

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

8 messages Options

oddhack

Aug 01, 2020; 1:57am

Apache plugin to render .adoc on server side?

Is there an Apache plugin which will translate .adoc to HTML on the fly and serve the rendered result, rather than the source markup? I've browsed the archives and web search without turning up obvious matches. The use case is to reflect an internal gitlab repository through Apache, conceptually similar to github.io, and rendering README.adoc in the webserver would be very helpful for this.

Of course individuals can install something like Asciidoctor.js Preview on the client side, but a lot of our users will be marketing people and lawyers who won't be up for that sort of thing.

Jon

mojavelinux

Aug 03, 2020; 9:18am

Re: Apache plugin to render .adoc on server side?

Administrator

Jon,

I'm not aware of one. In the case of GitLab, I know that it already supports rendering .adoc files using github/markup (which, in turn, uses Asciidoctor).

For something more low-level, I imagine the specification effort will help with this as we could see a C implementation out of it. That's going to integrate a lot better with Apache httpd. Integrations will be something the working group will help advocate for and promote.

Best Regards,

-Dan

On Fri, Jul 31, 2020 at 7:57 PM oddhack [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Is there an Apache plugin which will translate .adoc to HTML on the fly and serve the rendered result, rather than the source markup? I've browsed the archives and web search without turning up obvious matches. The use case is to reflect an internal gitlab repository through Apache, conceptually similar to github.io, and rendering README.adoc in the webserver would be very helpful for this.

Of course individuals can install something like Asciidoctor.js Preview on the client side, but a lot of our users will be marketing people and lawyers who won't be up for that sort of thing.

Jon

If you reply to this email, your message will be added to the discussion below:
https://discuss.asciidoctor.org/Apache-plugin-to-render-adoc-on-server-side-tp8132.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML

Dan Allen (he, him, his) | @mojavelinux | https://twitter.com/mojavelinux

dalai

Aug 03, 2020; 2:14pm

Re: Apache plugin to render .adoc on server side?

In reply to this post by oddhack

Is live-rendering really needed? If the sources are in source control a hook could be used to generate the static html and you could serve that.

Otherwise it may be possible to use Apache as a proxy and have the gitlab instance serve the rendered content (just) for adoc files.

It depends on what exactly you want to achieve.

oddhack

Aug 03, 2020; 4:00pm

Re: Apache plugin to render .adoc on server side?

Not essential, no. That is a viable alternative.

The annoying thing is that we can't serve HTML / PDF out of the gitlab web interface, nor processed .adoc out of Apache, so it's difficult to get a view of the repo that does both things. We're constrained to a self-hosted gitlab server here, alas.

dalai

Aug 03, 2020; 7:36pm

Re: Apache plugin to render .adoc on server side?

So are Gitlab Pages insufficient or does the gitlab instance need to remain isolated?

Alexander Schwartz

Aug 03, 2020; 8:15pm

Re: Apache plugin to render .adoc on server side?

To elaborate on dalai's response:

a build process based on a gitlab runner could fill the contents of gitlab pages by rendering HTML and/or PDF from the AsciiDoc of the repository
the build could trigger once the content in the repository changes and refresh the gitlab pages
from what I heard: gitlab pages can be access restricted with the same permissions mechanism as the repository
a static site generator (jekyll, jbake, etc.) could provide a navigation if an AsciiDoc file or a static HTML file is not sufficient

Alexander Schwartz (alexander.schwartz@gmx.net)
https://www.ahus1.de

oddhack

Aug 04, 2020; 12:32am

Re: Apache plugin to render .adoc on server side?

In reply to this post by dalai

Unfortunately, the content must remain private. Otherwise we'd just use github.io to begin with.

mojavelinux

Aug 04, 2020; 6:02am

Re: Apache plugin to render .adoc on server side?

Administrator

Access to GitLab Pages can be restricted, both on GitLab.com and self-hosted instances.

See https://docs.gitlab.com/ee/administration/pages/index.html#access-control

-Dan

On Mon, Aug 3, 2020, 18:32 oddhack [via Asciidoctor :: Discussion] <[hidden email]> wrote:

Unfortunately, the content must remain private. Otherwise we'd just use github.io to begin with.

If you reply to this email, your message will be added to the discussion below:
https://discuss.asciidoctor.org/Apache-plugin-to-render-adoc-on-server-side-tp8132p8141.html

To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML