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 marking a documentation page as the landing page #2567

Closed
jcomack opened this issue Apr 9, 2020 · 1 comment · Fixed by #2652
Closed

Allow marking a documentation page as the landing page #2567

jcomack opened this issue Apr 9, 2020 · 1 comment · Fixed by #2652
Labels
feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future.

Comments

@jcomack
Copy link
Contributor

jcomack commented Apr 9, 2020

🚀 Feature

Allow maintainers to configure a documentation page as their landing page.

Have you read the Contributing Guidelines on issues?

Yes

Motivation

Currently, Docusaurus allows users to setup in a 'docs only' mode, which requires setting your routeBasePath to an empty string and redirecting visitors by altering the /src/pages/index.js file so it points to your desired destination.

However, this means you're (needlessly) redirecting a visitor to a different URL and thus are leaving the original 'landing page' that you'd expect to see when visiting https://myawesomedocs.com/, for example. Manually recreating the layout of your documentation pages in the index.js file is also an option, but seems cumbersome.

Pitch

Allowing maintainers to mark a particular documentation page as their landing page, would get rid of having to change the settings/files I mentioned before and make it easier for people to get a 'docs only' site up and running. Additionally, I believe it could also benefit in terms of SEO, as you aren't redirecting people "for no reason".

@jcomack jcomack added feature This is not a bug or issue with Docusausus, per se. It is a feature request for the future. status: needs triage This issue has not been triaged by maintainers labels Apr 9, 2020
@yangshun yangshun removed the status: needs triage This issue has not been triaged by maintainers label Apr 9, 2020
@yangshun
Copy link
Contributor

yangshun commented Apr 9, 2020

We could add an option to the @docusaurus/plugin-content-docs to specify the root route to map to another doc route.

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

Successfully merging a pull request may close this issue.

2 participants