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 docs in html or at least make the current less ugly #15

Closed
camilamaia opened this issue Jul 21, 2019 · 4 comments
Closed

Generate docs in html or at least make the current less ugly #15

camilamaia opened this issue Jul 21, 2019 · 4 comments
Labels
Feature New feature or request Help Wanted Extra attention is needed from the maintainer or core devs. Reporter Related with the API doc generated by ScanAPI

Comments

@camilamaia
Copy link
Member

Current the format is markdown.
@camilamaia camilamaia added the Help Wanted Extra attention is needed from the maintainer or core devs. label Jul 21, 2019
@camilamaia camilamaia changed the title Generate docs in html or at least make it less uglier Generate docs in html or at least make it less ugly Jul 22, 2019
@camilamaia camilamaia added Feature New feature or request Reporter Related with the API doc generated by ScanAPI labels Aug 6, 2019
@barbosa
Copy link
Member

barbosa commented Oct 9, 2019 •
edited

Jinja would be a good candidate here. For both Markdown and HTML.

It also could be an option for the CLI like --report markdown or --report html.

And in the future, have an even more flexible para like --template my_beautiful_page.html where developers can use whatever they want + CSS 💄.

@camilamaia camilamaia changed the title Generate docs in html or at least make it less ugly Generate docs in html or at least make the current less ugly Oct 9, 2019
@barbosa
Copy link
Member

barbosa commented Nov 2, 2019 •
edited

  • Make DocsWriter abstract
  • Create a MarkdownReporter based on the current code
  • Create a ConsoleReporter (for debugging purposes)
  • Use Jinja to render Markdown
  • Create a HTMLReporter: scanapi --reporter=html
  • Add support for templates

This was referenced Nov 4, 2019
Merged
Closed
@barbosa
Copy link
Member

barbosa commented Nov 5, 2019

@camilamaia I've broken this down to #58, #59, #60 and #61. Do you think we can close this then?

@camilamaia
Copy link
Member Author

Sure! I will do that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature New feature or request Help Wanted Extra attention is needed from the maintainer or core devs. Reporter Related with the API doc generated by ScanAPI
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@barbosa @camilamaia