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

Use the OpenAPI's title for rendered HTML pages #1068

Closed
ZakCodes opened this issue Oct 14, 2019 · 0 comments · Fixed by #1073
Closed

Use the OpenAPI's title for rendered HTML pages #1068

ZakCodes opened this issue Oct 14, 2019 · 0 comments · Fixed by #1073

Comments

@ZakCodes
Copy link
Contributor

When using the CLI, if you don't explicitly provide a title using the --title option, the title of the outputed page is ReDoc Documentation.

Instead of using the default title, ReDoc could use the title provided by the OpenAPI document that is being rendered. In the OpenAPI standard, there's an info object in the root of the document with a title property that could be used. This property is already used by ReDoc cli at the very beginning of the rendered HTML page.

I would understand if you would like to keep it like that for advertising, but I think it's really annoying because I need to copy the title from my OpenAPI document and pass it to ReDoc cli, so whenever I want to change a title, I need to remember to change it in my rendering scripts.
I think the title of an HTML document isn't what's going to give you the most publicity since the users can't even click on it. Therefore, if you really want to advertise this tool, you would be better off adding a link to ReDoc right under the title in the HTML body where people can click on, just like you did in the left sidebar.

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

Successfully merging a pull request may close this issue.

2 participants