Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

No .adoc output #1

Closed
omfgnuts opened this issue Aug 4, 2022 · 3 comments
Closed

No .adoc output #1

omfgnuts opened this issue Aug 4, 2022 · 3 comments
Labels
good first issue Good for newcomers

Comments

@omfgnuts
Copy link

omfgnuts commented Aug 4, 2022

Heyo @raldone01!

It seems like your asciidoc plugin is the only asciidoc+typedoc combo out there, and I'm in a desperate need to use it.

Is there a configuration that I'm missing, because I specified readme entry, but it doesn't generate any. I tried Markdown plugin, and it works as it should. Can you please suggest what I should be looking at or any debug options to see what's wrong?

@raldone01
Copy link
Member

raldone01 commented Aug 4, 2022

What this plugin does:

Take a 'README.adoc' and render it to 'html' before sending it off to typedoc which then passes it to the output generator.

What this plugin does NOT do:

Add support for typedoc to generate '.adoc' output.

In other words

This plugin does NOT enable you to use ascii-doc in the javadoc comments ONLY in the README.
It also does NOT generate '.adoc' output. It only integrates an existing 'README.adoc' into the typedoc output.

If you think this plugin does what you want read on

Please try to run the example first.
Steps:

  1. Clone the repo
  2. cd into example
  3. pnpm i
  4. pnpm run docs
  5. Verify that the typedoc generated correctly

Only try to integrate my plugin into your project after you have verified that the example works.

You only have to set this option: https://github.com/ink-feather-org/typedoc-plugin-asciidoctor/blob/ec7804205e7d90a1688d093cd87a7bab2a8a6e31/example/tsconfig.json#L15

@omfgnuts
Copy link
Author

omfgnuts commented Aug 4, 2022

Now I get it. Much appreciated. Your reply could perfectly fit into repo's readme.

Thank you for your time

@raldone01
Copy link
Member

Updated the readme d0571f7. If you want to implement it feel free to use this plugin as basis. I would welcome a pull request.

@raldone01 raldone01 added the good first issue Good for newcomers label Aug 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants