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

Releases page support #399

Closed
montogeek opened this issue Jan 16, 2018 · 4 comments
Closed

Releases page support #399

montogeek opened this issue Jan 16, 2018 · 4 comments
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@montogeek
Copy link

Hello!

This is a great project that solves every author/maintainer problem: My library/framework website documentation.

Is there any plan to support a Releases page? This is extremely important in any library/framework website, show your users what changes were done in each release.

It could pull a CHANGELOG.md file or even Releases GH page info through the API to build a nice, eye candy page.

Of course, CHANGELOG.md or Releases notes could be written in so many ways, but after defining a standard for Docusaurus, every project would use it.

Please let me know your ideas, I could contribute it :)

@JoelMarcey JoelMarcey added the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Feb 27, 2018
@JoelMarcey
Copy link
Contributor

@montogeek Hi! Sorry it took me a while to get back to you.

So, you could theoretically create a releases.js under website/pages. But it seems like you are asking for a page built in that comes with Docusaurus, similar to the users.html or index.html pages.

I would be interested in your thoughts around this.

@montogeek
Copy link
Author

@JoelMarcey Yes, it should be created by Docusaurus, not by its users.

@JoelMarcey
Copy link
Contributor

@montogeek Could you provide an idea of what such a page might look like - or even better, propose a .js template that may fit into our pages directory with the other built in pages Docusaurus provides?

@endiliey
Copy link
Contributor

This should be left to user though because we don't want to dictate the look/ layout of the pages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.
Projects
None yet
Development

No branches or pull requests

3 participants