-
Notifications
You must be signed in to change notification settings - Fork 47
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
create image badge with result percentage or text block #280
Comments
I want to work on this issue, please assign this to me. |
Thanks a lot, @pujakarakoti07, I am happy that you apply to implement this new feature. Did you already check the mentioned docToolchain/docToolchain#456 issue of @arcusbude? It should be a starting point to implement this. If you have more ideas they are welcome. A graphical badge like the ones provided by https://img.shields.io/ would be great. Are you on (the Hacktoberfest) Discord? You can reach out to me (gerdaschemann) so we could have a chat if you run into problems (or if you need any other support). |
As stated on the docToolchain issue, we have a two step process:
The question is, what is the best way to integrate the result into the already generated HTML? Here are several ideas: HSC could generate a button which will be included in the HTML. The AsciiDoc source could reference a dummy image which gets replaced later. This way, the image would not generate a warning by HSC We could also setup an iFrame in AsciiDoc with a pass-through block. This could then later show the HSC results. This would not work for PDF generation Another approach could be to create a marker or placeholder in the document (something like %%HSC-RESULTS%%) which can be replaced later with the HSC report What do you think could be the best approach? Do you need help to setup a test environment? |
I would hope that we will see the final solution in HSC as well 😊. |
and it would also be great if we also use it over at docToolchain |
over at
docToolchain
a user asked if there is something resulting fomr anhtmlSanityCheck
which could be included in the docs.docToolchain/docToolchain#456
A badge could be the easiest solution to be included in docs, but I guess not easy to create.
A text snippet which reports the percentage of green text could help to create a status like the one proposed in the ticket mentioned above:
last updated 2020-08-06 08:17:52 htmlSanitycheck reports an status of <97%>
The text was updated successfully, but these errors were encountered: