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.

Sign up for GitHub

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

Jump to bottom

generate better docs: md and graphs #81

Open
rurban opened this issue Nov 13, 2019 · 3 comments
Open

generate better docs: md and graphs #81

rurban opened this issue Nov 13, 2019 · 3 comments
Labels
enhancement

Comments

@rurban
Copy link
Owner

rurban commented Nov 13, 2019 •
edited

Generate more informative docs.
markdown with graphs should be good enough.
Also generate more docs comparing the top 5 in each category.

see e.g. demerphq/smhasher
@rurban
Copy link
Owner Author

rurban commented Dec 4, 2019

At least we have now a sortable table, to see the top in the various categories.
http://rurban.github.io/smhasher/doc/table.html

@erthink
Copy link
Contributor

erthink commented Dec 4, 2019

Suggest add .txt extension to per-hash-log to be able view details in a browser.

@rurban
Copy link
Owner Author

rurban commented Dec 4, 2019 •
edited

Yes. Either .txt or .md.
Maybe .gitattributes can help also

rurban added a commit that referenced this issue Mar 7, 2020
@rurban
rename doc/* to doc/*.txt
6d12dc9 
needed for table.html
See GH #81
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rurban @erthink