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

Allow configurable URL value for "next" #718

Closed
Assignees
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: claimed Issue has been claimed by a contributor who plans to work on it.

Comments

@machikoyasuda
Copy link
Contributor

Is this a bug report?

✖️No

Have you read the Contributing Guidelines on issues?

✅ Yes

Feature request

Currently, Docusaurus hardcodes the URL param for the pre-release master branch as next. The version link in the header and the URLs use the word next. I'd like to be able to configure this field in siteConfig.js, because I'd like to be able to use the URL value master instead.

For example, instead of localhost:3000/docs/next/installation.html, I'd like to be able to use master instead: localhost:3000/docs/master/installation.html. This naming better aligns with the naming convention we already currently use in our docs and GitHub branch naming conventions.

Proposal:

Add an optional siteConfig.js variable that would allow users to set a custom name, like master, instead of the default, next.

@machikoyasuda
Copy link
Contributor Author

@JoelMarcey @yangshun If it's alright with y'all, I'd love to work on this 🤓

@JoelMarcey
Copy link
Contributor

I would love a PR on this. Thanks! As long as it doesn't break existing functionality, then I think we could consider this.

@JoelMarcey JoelMarcey added the status: claimed Issue has been claimed by a contributor who plans to work on it. label Jun 1, 2018
@endiliey endiliey added the feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. label Jun 1, 2018
@endiliey endiliey changed the title Feature request: Allow configurable URL value for "next" Allow configurable URL value for "next" Jun 1, 2018
@endiliey
Copy link
Contributor

Hi @machikoyasuda 😁
Are you still working on this ? Will be happy to help if you encounter a problem

@machikoyasuda
Copy link
Contributor Author

@endiliey I was able to get around this issue with Netlify redirects, so I'm not working on this anymore!

Someone else can claim if if interested, or close it :)

@endiliey
Copy link
Contributor

I am closing this then. Trying to avoid extra feature (especially in siteConfig) before v2.

@machikoyasuda
Copy link
Contributor Author

@endiliey Thank you for your vigilant maintainership <3

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