search

asciidoctor / asciidoctor-pdf

:page_with_curl: Asciidoctor PDF: A native PDF converter for AsciiDoc based on Asciidoctor and Prawn, written entirely in Ruby.
https://docs.asciidoctor.org/pdf-converter/latest/
MIT License
1.14k stars 501 forks source link

docs: add README to describe how to use extensions in these examples #2396

Closed lirantal closed 1 year ago

lirantal commented 1 year ago

This README helps users understand how to use the source code in the /examples folder so that they can apply theme extensions and other capabilities that extend asciidoctor-pdf

mojavelinux commented 1 year ago

Please make this a proper page in the docs. For one, that means making it an AsciiDoc file, not a Markdown file (this is an Asciidoctor project, after all). This content could be added to the Use Cases page. However, that may end up creating too much noise. So perhaps a new page named "How to Use Examples" would work.

This directory is only intended to be viewed through the docs, which is why I'm suggesting this information be part of the docs.

lirantal commented 1 year ago

Sure thing. Could you refer me to which files exactly need to be edited to add that context?

I don't know where the official docs are being managed. Whether they are on this repo, or somewhere else. If you can point me in the right direction I'm happy to shoot a new PR.

mojavelinux commented 1 year ago

I don't know where the official docs are being managed. Whether they are on this repo, or somewhere else.

There is an Edit this Page link on every page in the docs. Here's the page that presents the use cases for extending the converter. You should be able to start from there. https://docs.asciidoctor.org/pdf-converter/latest/extend/use-cases/

mojavelinux commented 1 year ago

I have documented where to find the source code for the use cases on the extended converter use cases page. These use cases are not meant to be viewed from the repository (hence why there is no README in the folder or the need for one). The entry point for this repository is the documentation. I think the documentation contains all the information you need to use the provided extended converters. See https://docs.asciidoctor.org/pdf-converter/latest/extend/use-cases/

If you feel that more explanation is needed, please propose a revision to the documentation.

lirantal commented 1 year ago

Thank you, Dan. This completely fall off my radar due to work travel, writing and a bunch of other things. Sincerely appreciate you were able to update the right docs ❤️

mojavelinux commented 1 year ago

Thank you for getting it started!