Allow subdirectories inside documentation folder

[krakowski]

Motivation

This feature was requested in #323.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Since the HTML output is now stored within subdirectories as well, I had to adjust a glob pattern. After this change all tests ran successfully.

Both the development server and the build output (served using Python's SimpleHTTPServer) reflect the desired result.

Changes

• A document's id is now determined by concatenating the relative path within docs and the document header's id field (or filename if the id field is missing).
• Docusaurus documents are now organized in subdirectories.
• The Navigation and Sidebars documentation has been updated.

Related Issues

• Closes Support sub-directories in docs/ #323 - Support sub-directories in docs/

Screenshots

[JoelMarcey]

@filkra Hi! Thank you for this PR. Sorry for the delay here - I am currently on vacation. I want to give this a real thorough review before approving/merging as this would be a very substantial change. I will look through this as I can while out, and then more when I get back.

[vladikoff]

This is cool, I'm gonna try using this fork 😄

[vladikoff]

This should probably be globally ignored on your machine to avoid polluting .gitignore, but same goes for the other ignored dirs above.

[yangshun]

I agree

[vladikoff]

should this be just api/pages?

[krakowski]

Hi, yes you're right. I will change it later this day. Thanks!

[vladikoff]

This might cause a bug here. If you compare this with the default website the /en/ is not part of urls.

But with this PR /en/ starts appearing in urls:

Maybe that should be determined by useEnglishUrl option

[krakowski]

Hi, thanks for your feedback! By default website you mean docusaurus.io? If so, /en/ already appears to be a part of the url (https://docusaurus.io/docs/en/installation.html).

[vladikoff]

@filkra sorry, I meant the website you get after you run docusaurus-init

[krakowski]

This seems to be more complicated than I thought... Using only useEnglishUrl doesn't work since the /en/ part will also be inserted, if a languages.js file exists. I ran docusaurus-init and created a languages.js file containing the following.

const languages = [
  {
    enabled: true,
    name: "English",
    tag: "en"
  }
];
module.exports = languages;

useEnglishUrl is set to false and the URL still contains /en/. Is this the right behaviour?

[yangshun]

@filkra Sorry for getting back to this so late. Could you rebase and update the branch? Will review this after that's done.

[yangshun]

I agree

[yangshun]

Closing due to inactivity. Feel free to reopen or submit a new PR if necessary.