-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
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
feat(cli): add docusaurus serve --no-clean-urls
option
#10552
Conversation
Hi @ZumiFlores! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at [email protected]. Thanks! |
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Thanks Can you please sign the CLA? I can't merge any PR without this. |
docusaurus serve --no-clean-urls
option
.option('--no-clean-urls', 'Disable clean URLs (keep .html extensions)') | ||
.parse(process.argv); | ||
|
||
const { noCleanUrls } = program.opts(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
CI reports error:
Error: 46:11 error 'noCleanUrls' is assigned a value but never used @typescript-eslint/no-unused-vars
You have to actually use the option for the PR to have any meaningful effect
You are not supposed to use Commander in this file, but in bin/docusaurus.mjs
The param of this serve function ServeCLIOptions
should contain cleanUrls: boolean
and you should pass this arg to serveHandler
here:
serveHandler(req, res, {
cleanUrls: true,
public: outDir,
trailingSlash,
directoryListing: false,
});
This PR adds the ability to configure the cleanUrls option for the serve command, as described in issue #7991. It allows users to toggle clean URLs during local development.
Pre-flight checklist
Motivation
Test Plan
Test links
Deploy preview: https://deploy-preview-10552--docusaurus-2.netlify.app/
Related issues/PRs
Fix #7991