fix(v2): accessing /docs or /docs/xxxx should not be empty #1903

endiliey · 2019-10-28T10:01:19Z

Motivation

When accessing https://v2.docusaurus.io/docs or https://v2.docusaurus.io/docs/xxxxx we'll see only blank page because it match @theme/DocPage

So we should check in docpage if there's matching route, otherwise render notfound page

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

https://deploy-preview-1903--docusaurus-2.netlify.com/docs/
https://deploy-preview-1903--docusaurus-2.netlify.com/docs/xxx

docusaurus-bot · 2019-10-28T10:05:52Z

Deploy preview for docusaurus-2 ready!

Built with commit 181f53a

https://deploy-preview-1903--docusaurus-2.netlify.com

docusaurus-bot · 2019-10-28T10:06:23Z

Deploy preview for docusaurus-preview ready!

Built with commit 181f53a

https://deploy-preview-1903--docusaurus-preview.netlify.com

lex111 · 2019-10-28T13:07:56Z

If I go to the URL https://deploy-preview-1903--docusaurus-2.netlify.com/docs/xxx I will get the following:

endiliey · 2019-10-28T14:01:01Z

@lex111 true. Its because of nested route 😭 The DocPage renders first. I crafted this PR too hastily ✌️ and submitted the wrong solution

Edit: try again now

endiliey · 2019-10-28T14:41:37Z

Try again. Hopefully should be correct now

yangshun · 2019-10-28T15:31:29Z

packages/docusaurus/src/client/exports/router.js

@@ -0,0 +1,8 @@
+/**


Are we gonna document this as a user-facing module?

Probably few of them. I am afraid someone will use BrowserRouter inside pages

Lets put it as hidden feature for now. I think matchPath is fine, and maybe react router hooks like useLocations

yangshun · 2019-10-28T15:31:57Z

packages/docusaurus-theme-classic/src/theme/DocPage/index.js

 function DocPage(props) {
  const {route, docsMetadata, location} = props;
  const {permalinkToSidebar, docsSidebars} = docsMetadata;
  const sidebar = permalinkToSidebar[location.pathname.replace(/\/$/, '')];
  const {siteConfig: {themeConfig = {}} = {}} = useDocusaurusContext();
  const {sidebarCollapsible = true} = themeConfig;

+  if (!matchingRouteExist(route.routes, location.pathname)) {


Wonder if there's a way to do this automatically for all plugins. Should it be done automatically?

We shouldn't. Some theme might want different behavior. E.g: render a table of content of all available docs routes, or maybe display all available versions, etc. Very UI dependent

lex111

It works perfectly for me.

* feat(v2): highlight items in the table of content * refactor: move string to const * refactor(v2): Convert sitemap plugin to TypeScript (#1894) * Convert sitemap plugin to TypeScript Test - enabled the sitemap plugin in the v2 website and verified that the sitemap is created after running `docusaurus build`. * Addressing review comments * perf(v2): significantly reduce bundle size & initial html payload (#1898) * perf(v2): reduce bundle size significantly with super short chunk name and registry * changelog * use hash:8 as id for better long term caching * even shorter filename. slice contenthash * fix(v2): align search icon on small width device (#1893) * fix(v2): align search icon on small width device * nits * nits * refactor(v2): refactor dark toggle into a hook (#1899) * change(v2): refactor dark toggle into a theme * follow how themes resolve files * let theme hook to pick up default theme by itself * perf(v2): reduce memory usage consumption (#1900) * misc(v1): use primary color for hovered items in table of contents (#1871) * fix issue#1752 when element in side nav is hovered over the color changes. * Update main.css * fix(v1): mobile safari search input misalignment in header (#1895) * misc(v2): v1 backward compatibility for USE_SSH env var (#1880) * misc(v2): address comments * misc(v2): update CHANGELOG * feat(v2): allow line highlighting (#1860) * feat(v2): allow line highlighting * Refactor: use parse-numeric-range for parsing * Add line highlighting for live code blocks * feat(v2): add sticky footer (#1855) * feat(v2): add sticky footer * Update CHANGELOG-2.x.md * Update CHANGELOG-2.x.md * fix(v2): remove empty doc sidebar container (#1870) * docs: showcase user Amphora (#1873) * Add Amphora Data link to users Adds Amphora Data to the list of users * Add Amphora Data logo * fix case of image path * Move Image into users directory * use black amphora image * fix(v2): fix search input blur on desktop (#1874) * docs(v2): showcase user mbt-bundle (#1875) * feat(v2): postcss should only use stage 3 features instead of stage 2 (#1872) * feat(v2): add ability expand all items in doc sidebar (#1876) * feat(v2): add ability expand all items in doc sidebar * Fix tests * Refactor: use themeConfig * Improve docs * Revert unnecessary changes * Refactor: better consistency * Revert extra change * Refactor: use useDocusaurusContext to get config value * chore(v2): update changelog * chore(v2): update showcase and broken link * perf(v2): disable hash for css modules localident in dev (#1882) * perf(v2): disable hash for css modules localident in dev * changelog * feat(v2): display footer in docs page for consistency (#1883) * feat(v2): display footer in docs page * nits * address review * nits * docs(v2): fix format inline code (#1888) * docs(v2): add docs on useful client api (#1890) * docs(v2): add docs on useful client api * Update docusaurus-core.md * Update website/docs/docusaurus-core.md * Update website/docs/docusaurus-core.md * Update website/docs/docusaurus-core.md * Update website/docs/docusaurus-core.md * docs(v2): update config docs (#1885) * fix(v2): do not show categories with empty items (#1891) * styles(v2): update infima and fix styles (#1892) * fix(v2): wrong css class * v2.0.0-alpha.31 * chore(v2): update docs and changelog * docs(v2): update plugins, presets and themes docs (#1889) * docs(v2): update plugins, presets and themes docs * ideal image plugin * proof reading * Merge master * refactor(v2): Convert sitemap plugin to TypeScript (#1894) * Convert sitemap plugin to TypeScript Test - enabled the sitemap plugin in the v2 website and verified that the sitemap is created after running `docusaurus build`. * Addressing review comments * perf(v2): significantly reduce bundle size & initial html payload (#1898) * perf(v2): reduce bundle size significantly with super short chunk name and registry * changelog * use hash:8 as id for better long term caching * even shorter filename. slice contenthash * fix(v2): align search icon on small width device (#1893) * fix(v2): align search icon on small width device * nits * nits * refactor(v2): refactor dark toggle into a hook (#1899) * change(v2): refactor dark toggle into a theme * follow how themes resolve files * let theme hook to pick up default theme by itself * perf(v2): reduce memory usage consumption (#1900) * misc(v1): use primary color for hovered items in table of contents (#1871) * fix issue#1752 when element in side nav is hovered over the color changes. * Update main.css * fix(v1): mobile safari search input misalignment in header (#1895) * misc(v2): v1 backward compatibility for USE_SSH env var (#1880) * misc(v2): address comments * misc(v2): update CHANGELOG * docs(v1): remove user Vasern (#1901) * misc: update URLs to non-HTML versions (#1902) * Update README.md - Fix Broken Link * misc: update URLs to non-HTML versions * misc(v2): improve index page SEO score * fix(v2): accessing /docs or /docs/xxxx should not be empty (#1903) * fix(v2): nested routes should have wildcard/ not found page too * better fix * nits * space * docs(v2): code block line highlighting (#1904) * docs(v2): code block line highlighting * misc: update CHANGELOG * misc: respond to review * docs: add line highlighting to the template * fix(v2): webpack modules resolve should prioritize @docusaurus/core own deps (#1907) * fix(v2): webpack modules resolve should prioritize own deps * nits * feat(v2): simplify blog metadata to minimize number of request (#1908) * feat(v2): simplify blog metadata to minimize number of request * remove async * feat(v2): add ability to set custom HTML in footer items (#1905) * docs: update configcat user link (#1911) * fix(v2): docs plugin stability improvement (100% test coverage) (#1912) * update jest config * add more tests on docs plugin * fix(v2): docs plugin should not add routes if there are no docs * fix * rm -rf coverage * nits * update * docs(v2): add windows batch instructions for publishing to gh pages (#1914) * docs: add windows batch instructions for publishing to gh pages * docs: add windows batch instructions on the v2 website * fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined (#1909) * fix(v2): custom searchbar should appear even if themeconfig.algolia is undefined * nits * Docs docs * inaccuracy * changelog * nits * fix(v2): missing/hidden algolia search suggestion result (#1915) * docs(v2): Redirect component for easy redirect (#1913) * docs(v2): Redirect component for easy redirect * typo * docs * Update website/docs/docusaurus-core.md Co-Authored-By: Alexey Pyltsyn <[email protected]> * Update docusaurus-core.md * refactor: changes after comments (use custom hooks, code changes, fix bugs) * fix(v2): regression from prioritizing core node_modules logic (#1917) * fix(v2): regression from prioritizing core node_modules logic * nits * chore: changelog * docs(v1): showcase user Reactive Interaction Gateway (#1918) * chore: bump dependencies * docs(v2): fix typo in advanced plugins (#1926) * docs(v2): fix typos (#1930) * docs(v1): fix links in CHANGELOG (#1931) * fix(v2): @theme/heading should not create anchor if id is not defined (#1925) * docs(v2): theme, plugin, and preset config (#1929) * docs(v2): theme, plugin, and preset config * change tabs to spaces * change theme example * misc: use /usr/bin/env bash to increase portability (#1923) * misc(v1): use Node.js lts version (#1920) This is much stable and more performant * chore: downgrade imagemin (#1933) * fix(v2): add missing key prop in footer items with HTML (#1935) * fix(v2): fix browser window background (#1936) * fix(v2): allows to create tabs with only one item (#1934) * fix(v2): allow to create tabs with only one item It was not possible to have tabs containing only one tab item, so the code below crashed ``` <Tabs defaultValue="SomeFile.js" values={[ { label: "SomeFile.js", value: "SomeFile.js" } ]} > <TabItem value="SomeFile.js"> Tab content </TabItem> </Tabs> ``` * Update index.js * fix(v2): remove redundant npm script in classic template (#1937) * v2.0.0-alpha.32 * chore(v2): changelog * misc(v2): update TOC highlight * misc(v2): update CHANGELOG

fix(v2): nested routes should have wildcard/ not found page too

e7532e3

endiliey requested a review from yangshun as a code owner October 28, 2019 10:01

facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 28, 2019

endiliey added the status: don't merge yet This PR is completed, but we are still waiting for other things to be ready. label Oct 28, 2019

endiliey removed the request for review from yangshun October 28, 2019 14:01

endiliey changed the title ~~fix(v2): nested routes should have wildcard/ not found page too~~ fix(v2): accessing /docs or /docs/xxxx should not be empty Oct 28, 2019

endiliey changed the title ~~fix(v2): accessing /docs or /docs/xxxx should not be empty~~ WIP - fix(v2): accessing /docs or /docs/xxxx should not be empty Oct 28, 2019

endiliey added 3 commits October 28, 2019 21:32

better fix

77702c6

nits

8315ff9

space

181f53a

endiliey changed the title ~~WIP - fix(v2): accessing /docs or /docs/xxxx should not be empty~~ fix(v2): accessing /docs or /docs/xxxx should not be empty Oct 28, 2019

endiliey removed the status: don't merge yet This PR is completed, but we are still waiting for other things to be ready. label Oct 28, 2019

yangshun approved these changes Oct 28, 2019

View reviewed changes

lex111 approved these changes Oct 28, 2019

View reviewed changes

yangshun merged commit 7714afb into master Oct 28, 2019

endiliey deleted the endi/fallback branch October 29, 2019 08:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(v2): accessing /docs or /docs/xxxx should not be empty #1903

fix(v2): accessing /docs or /docs/xxxx should not be empty #1903

endiliey commented Oct 28, 2019 •

edited

Loading

docusaurus-bot commented Oct 28, 2019 •

edited

Loading

docusaurus-bot commented Oct 28, 2019 •

edited

Loading

lex111 commented Oct 28, 2019

endiliey commented Oct 28, 2019 •

edited

Loading

endiliey commented Oct 28, 2019 •

edited

Loading

yangshun Oct 28, 2019

endiliey Oct 28, 2019

endiliey Oct 28, 2019

yangshun Oct 28, 2019

endiliey Oct 28, 2019

lex111 left a comment

fix(v2): accessing /docs or /docs/xxxx should not be empty #1903

fix(v2): accessing /docs or /docs/xxxx should not be empty #1903

Conversation

endiliey commented Oct 28, 2019 • edited Loading

Motivation

Have you read the Contributing Guidelines on pull requests?

Test Plan

docusaurus-bot commented Oct 28, 2019 • edited Loading

docusaurus-bot commented Oct 28, 2019 • edited Loading

lex111 commented Oct 28, 2019

endiliey commented Oct 28, 2019 • edited Loading

endiliey commented Oct 28, 2019 • edited Loading

yangshun Oct 28, 2019

Choose a reason for hiding this comment

endiliey Oct 28, 2019

Choose a reason for hiding this comment

endiliey Oct 28, 2019

Choose a reason for hiding this comment

yangshun Oct 28, 2019

Choose a reason for hiding this comment

endiliey Oct 28, 2019

Choose a reason for hiding this comment

lex111 left a comment

Choose a reason for hiding this comment

endiliey commented Oct 28, 2019 •

edited

Loading

docusaurus-bot commented Oct 28, 2019 •

edited

Loading

docusaurus-bot commented Oct 28, 2019 •

edited

Loading

endiliey commented Oct 28, 2019 •

edited

Loading

endiliey commented Oct 28, 2019 •

edited

Loading