Skip to content
This repository has been archived by the owner on Dec 28, 2022. It is now read-only.

Live Preview is not Antora compatible #300

Open
jaredmorgs opened this issue Nov 25, 2019 · 0 comments
Open

Live Preview is not Antora compatible #300

jaredmorgs opened this issue Nov 25, 2019 · 0 comments

Comments

@jaredmorgs
Copy link
Member

jaredmorgs commented Nov 25, 2019

Description

Improve the Atom Asciidoctor live preview so it supports the opinionated include directive module structure implemented in Antora.

  • Atom version: 1.41.0 x64
  • OS:
  • asciidoc-preview version: 2.13.1
  • language-asciidoc version: 1.11.0

Screenshots

image

Syntax example

Based on this directory structure, I should be able to include the files like this:

= JSON Web Token

include::_partials$docs-variables.adoc[]
include::_partials$in-page-toc.adoc[]
include::_partials$parameters-asciidoc.adoc[]
include::_partials$standard-anchors.adoc[]

== Overview

{description}

The JWTs created by the extension are signed using a secret and are encoded using the HMAC SHA256 standard.

The include directive structure can not be rendered in the main Antora module file if the partials are stored in the same module as the pages.

image

This makes it challenging for folks trying to check if the partials are including correctly locally without having to spin up an Antora environment locally.

It would be great if the Live Preview renderer could interpret basic Antora include directives so it could render them locally.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant