-
-
Notifications
You must be signed in to change notification settings - Fork 737
patch: use marked 0.6.0 to support id generation for headers #966
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
Conversation
Thanks for the contribution. Could you change a test to demonstrate this? Let us know if you have questions. |
@aciccarello yeah, sure |
@aciccarello how can I point out that I use If I use app = new Application({
mode: 'Modules',
logger: 'none',
target: 'ES5',
module: 'CommonJS',
experimentalDecorators: true
}); it will provide useless output {
"id": 0,
"kind": 0,
"flags": {}
} How can it be resolved? |
The file isn't converted because it is not a typescript file. Only the readme markdown file is parsed by default. You'll probably want to change the |
@aciccarello I think it's ready |
@@ -81,6 +81,15 @@ <h3 id="arguments">Arguments</h3> | |||
<li><code>--example <project></code><br> | |||
Example explanation.</li> | |||
</ul> | |||
<h2 id="example-with-cyrillic">Example with Cyrillic</h2> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
first case, only Latin, should be with hyphen as it was
@@ -81,6 +81,15 @@ <h3 id="arguments">Arguments</h3> | |||
<li><code>--example <project></code><br> | |||
Example explanation.</li> | |||
</ul> | |||
<h2 id="example-with-cyrillic">Example with Cyrillic</h2> | |||
<h3 id="пример-api">Пример API</h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
second case, combined Latin and Cyrillic
it would be id="-api"
without patching
<blockquote> | ||
<p>Combined Latin and Cyrillic text</p> | ||
</blockquote> | ||
<h3 id="только-кириллица">Только кириллица</h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
third case, only Cyrillic
it would be id="-"
without patching
@aciccarello is everything good? |
Sorry for the delay. Somehow I missed your updates. Looks great! |
Release of [email protected]
Added feature with Slugger
Problem: README contains links to different headers which cannot be properly generated (Github is instead working just fine with it)
Fix: After updating version of
marked
id generation is automatically supportedHow to reproduce: Get README where there are some relative links
#link-to-header
, usetypedoc
and see thatid
is-
or something elseAfter fix: id is properly added and links are working fine like in Github