alekitto / class-finder

Utility classes to help discover other classes/namespaces
https://alekitto.github.io/class-finder/
MIT License
27 stars 6 forks source link

Fix Markdown in finder.md #17

Closed szepeviktor closed 8 months ago

codecov[bot] commented 8 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 91.13%. Comparing base (b4afadf) to head (bfa0e5f).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #17 +/- ## ========================================= Coverage 91.13% 91.13% Complexity 341 341 ========================================= Files 35 35 Lines 767 767 ========================================= Hits 699 699 Misses 68 68 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

alekitto commented 8 months ago

Not a bug. This is used to create this in the rendered documentation:

image

szepeviktor commented 8 months ago

I see. So this is GitHub Pages/Jekyll syntax.

llaville commented 8 months ago

@alekitto Could you tell us what is engine to produce https://alekitto.github.io/ ?

Because standard admonition usage is described by https://docs.github.com/fr/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

szepeviktor commented 8 months ago

It must a front-end renderer: docsify -> docsify-themeable -> "Notices" https://jhildenbiddle.github.io/docsify-themeable/#/markdown?id=notices

But was unable to find where notices are rendered!

alekitto commented 8 months ago

That's correct, I've used docsify for the documentation (quick and easy to set up). I think that the alert is rendered in the marked package that converts the md files into html. Probably there's an extension to support GH alerts, but should be included and configured properly