Option to export AsciiDoc doc strings
See original GitHub issueOne of the attendees at Devoxx France proposed the idea of having an option in Asciidoclet to export all AsciiDoc doc strings to disk (i.e., export-docstrings). Exporting the strings would allow the content to be reused in other context or by other tools.
I really like this idea as a way to keep content DRY, especially if Javadoc is being treated as the canonical source of information for a portion of the documentation. It’s the inverse strategy to using the include tag.
I imagine that each doc string would be exported to a file that is named according to where the doc string originated (package name + [class name] + [method name]). These files would be exported to the build output adjacent to the javadoc directory.
Issue Analytics
- State:
- Created 8 years ago
- Reactions:2
- Comments:11 (6 by maintainers)
Top Results From Across the Web
Load and Convert Strings Using the API - Asciidoctor Docs
This page explains how to load and convert AsciiDoc strings using the API. ... HTML to a file from an AsciiDoc string, the...
Read more >AsciiDoc User Guide
The asciidoc(1) command translates an AsciiDoc formatted file to the backend format specified by the -b ( --backend ) command-line option.
Read more >Using AsciiDoc and Asciidoctor to write documentation - Tutorial
AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs.
Read more >AsciiDoc - Visual Studio Marketplace
The extension provides a quick command to export your AsciiDoc file as HTML using the default Asciidoctor stylesheet. ... The shortcut key of...
Read more >AsciidoctorJ | Asciidoctor
Converting documents ; convertFiles. String[]. Parses a collection of AsciiDoc files and converts them to the format specified by the backend option.
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

I’ve started a new project to output the raw contents of Javadocs to files. This can be used as part of the toolchain to incorporate the javadocs from a project into the final documentation.
You can find this project here: https://github.com/johncarl81/outputdoclet I figure we should continue this discussion about requirements and capabilities there.
Hello again @johncarl81,
I think that this pull request is a good start point. We can continue the discussion there.