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

Output as markdown #61

Open
digininja opened this issue Aug 18, 2023 · 4 comments
Open

Output as markdown #61

digininja opened this issue Aug 18, 2023 · 4 comments

Comments

@digininja
Copy link
Owner

@Lexus89 As a user of the tool, how would you feel if I update the output to produce markdown rather than basic text? I'm thinking about it as it would then let me do markdown to HTML for some nicer reports.

@digininja
Copy link
Owner Author

I've just committed a checker called basic_markdown which outputs as markdown. The only bit I've not worked out is the graphs, I'm still thinking about that.

@Lexus89
Copy link

Lexus89 commented Aug 18, 2023

It indeed would be nice to have HTML as an additional output format, besides the current regular text output. Something easy to parse for adding the data into other custom reports. Thanks I will be testing it out next week!

@Lexus89
Copy link

Lexus89 commented Aug 23, 2023

After enabling the markdown checker I do get some messages like the following:

pipal/checkers_available/basic_markdown.rb:9: warning: already initialized constant Basic Checker::FIRST_CAP_LAST_NUM_RE

For various checkers I also get listings with just 1s:

Top 10 base words

  1. password
  2. welcome
  3. letmein

@digininja
Copy link
Owner Author

It sites over the top of the normal basic so you need to remove that one for this to work, I should have renamed it internally.

It looks like GitHub has styled your 1's. In markdown, you do ordered lists with 1. starting everything, the renderer then puts the numbers in. You can do it with incrementing numbers but don't have to so it is easier for me just to hardcode 1. rather than do increments.

I'm going to try to do graphs today. From what I've seen, the only real way to do them would be to create images and reference them as external files. I'd rather have everything in a single file but looks like I won't be able to do that. I'll see how it goes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants