feat(core): allow sourcing from multiple static directories #4095

oriooctopus · 2021-01-24T05:40:17Z

This is a WIP

netlify · 2021-01-24T05:43:38Z

[V1] Deploy preview failure

Built without sensitive environment variables with commit b4423b0

https://app.netlify.com/sites/docusaurus-1/deploys/600d08435d5ff20009fbd5ed

github-actions · 2021-01-24T05:47:29Z

Size Change: 0 B

Total Size: 28.8 kB

ℹ️ View Unchanged

Filename	Size	Change
`website/build/blog/2017/12/14/introducing-docusaurus/index.html`	21.7 kB	0 B
`website/build/docs/introduction/index.html`	180 B	0 B
`website/build/index.html`	6.88 kB	0 B

_{compressed-size-action}

netlify · 2021-01-24T05:48:11Z

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 4901a12

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/6196526d6bc8d9000782b008

😎 Browse the preview: https://deploy-preview-4095--docusaurus-2.netlify.app

github-actions · 2021-01-24T05:48:30Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟢 Performance	92
🟢 Accessibility	98
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

Lighthouse ran on https://deploy-preview-4095--docusaurus-2.netlify.app/

slorber

Thanks for working on this!

What I suggest:

use default() in config validation
get rid of the STATIC_DIR_NAME constant, to ensure the configured array is used everywhere
support the static dir array in the mdx loader

packages/docusaurus/src/commands/build.ts

packages/docusaurus/src/commands/start.ts

packages/docusaurus/src/server/configValidation.ts

slorber

That looks nice 👍

We should support static dir array in mdx loader too

As you are on it, one idea I had is to have a i18n/<locale>/static folder as a convention for localized assets, as we don't have a good way to localize static assets currently

slorber · 2021-11-17T12:37:25Z

packages/docusaurus/src/commands/start.ts

@@ -187,17 +186,17 @@ export default async function start(
      // Reduce log verbosity, see https://github.com/facebook/docusaurus/pull/5420#issuecomment-906613105
      stats: 'summary',
    },
-    static: {
+    static: siteConfig.staticDirectories.map((dir) => ({


oh, hopefully they allow an array here 😅

Yeah, they do:
https://webpack.js.org/configuration/dev-server/#directory
https://webpack.js.org/plugins/copy-webpack-plugin/#root

The one thing I'm slightly worried about though is path collisions. I don't know if any warning should be given in that case

Josh-Cena · 2021-11-17T12:55:58Z

We should support static dir array in mdx loader too

Yes, realized that

one idea I had is to have a i18n/<locale>/static folder as a convention for localized assets

I'd always used /static/zh-Hans/img/ instead, which also works great with URL mapping. But seems i18n/zh-Hans/static works better with Crowdin🤔

One thing I didn't particularly like about the MDX loader is it converts static paths to require calls. Before I delve into the internals, as a user, I always thought that I was referencing a URL path with /img/docusaurus.png instead of a file path ㄟ(▔,▔)ㄏ

slorber · 2021-11-17T12:59:13Z

I'd always used /static/zh-Hans/img/ instead, which also works great with URL mapping. But seems i18n/zh-Hans/static works better with Crowdin🤔

Oh yes didn't think about that 😅 this is probably enough for now. Assets may not need to be uploaded to Crowdin. We'll see if someone ask for this extra i18n static path

One thing I didn't particularly like about the MDX loader is it converts static paths to require calls.

This is important so that assets enter the Webpack pipeline instead of just being referenced strings.

This leads to assets being hashed, providing better long-term caching.

And also we might have a better image infra someday, allowing you to use ideal image on markdown files with simple md syntax. Some image-heavy docs have annoying image-related layout shifts atm (can probably be solved with width/height in the short term anyway)

Josh-Cena · 2021-11-18T10:22:54Z

@slorber I'm done 👍 Things are working very well and we also get to separate the dogfooding assets from the actual assets the site is using. Also separated Markdown assets fully from static assets documentation—after this is merged we can close #3198 as well

slorber

That looks great, and it's nice to have moved the dogfood assets!

Just minor changes:

Support absolute path? I can see some users that may want to do that (those using home-made deployment on their own corporate servers in particular)
Tests should rather cover arrays with multiple static dirs

packages/docusaurus-plugin-content-pages/src/index.ts

website/docusaurus.config.js

packages/docusaurus-mdx-loader/src/remark/transformImage/__tests__/index.test.ts

packages/docusaurus-mdx-loader/src/remark/transformLinks/__tests__/index.test.ts

website/docusaurus.config.js

[WIP] Implementaion of multiple directory static sourcing

b4423b0

oriooctopus requested review from lex111 and slorber as code owners January 24, 2021 05:40

facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 24, 2021

oriooctopus marked this pull request as draft January 24, 2021 17:49

slorber requested changes Jan 27, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

slorber changed the title ~~[WIP] Implementaion of multiple directory static sourcing~~ [WIP] Implementation of multiple directory static sourcing Feb 17, 2021

Josh-Cena marked this pull request as ready for review November 15, 2021 13:57

Josh-Cena self-requested a review as a code owner November 15, 2021 13:57

Josh-Cena added 2 commits November 17, 2021 11:32

Merge branch 'main' into static-directory-sourcing

ebe0ddd

Move default to validation

bff539a

Josh-Cena changed the title ~~[WIP] Implementation of multiple directory static sourcing~~ feat(core): allow sourcing from multiple static directories Nov 17, 2021

Josh-Cena added the pr: new feature This PR adds a new API or behavior. label Nov 17, 2021

Josh-Cena added 2 commits November 17, 2021 12:00

Update test

ab5c04f

Refactor

8f6a7c4

slorber reviewed Nov 17, 2021

View reviewed changes

Josh-Cena added 4 commits November 18, 2021 17:01

Port to MDX loader

639eb7a

Fix

fb7c91d

Move dogfooding assets

99a8029

Doc writeup

dc965ea

Josh-Cena mentioned this pull request Nov 18, 2021

docs: move markdown-specified things out of global static-assets #5896

Closed

Restore assets

192d708

Josh-Cena linked an issue Nov 18, 2021 that may be closed by this pull request

Static assets doc on 2 pages #3198

Closed

slorber requested changes Nov 18, 2021

View reviewed changes

Josh-Cena added 2 commits November 18, 2021 19:18

Support absolute paths

d632103

Dogfood absolute path

6ea6814

slorber reviewed Nov 18, 2021

View reviewed changes

website/docusaurus.config.js Outdated Show resolved Hide resolved

Josh-Cena added 4 commits November 18, 2021 20:19

Fix

d2c8d27

More tests

5b11f98

Fix snapshots

52c353a

Merge branch 'main' into static-directory-sourcing

4901a12

Josh-Cena requested a review from slorber November 18, 2021 13:51

Josh-Cena merged commit 1366c31 into facebook:main Nov 18, 2021

This was referenced Nov 18, 2021

fix(core): apply staticDirectories to base webpack config #5965

Merged

feat(website): redesign of showcase page #5742

Merged

Josh-Cena mentioned this pull request Jan 8, 2022

Source static resources from multiple directories #3983

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(core): allow sourcing from multiple static directories #4095

feat(core): allow sourcing from multiple static directories #4095

oriooctopus commented Jan 24, 2021

netlify bot commented Jan 24, 2021

github-actions bot commented Jan 24, 2021

netlify bot commented Jan 24, 2021 •

edited

Loading

github-actions bot commented Jan 24, 2021 •

edited

Loading

slorber left a comment

This comment has been minimized.

slorber left a comment

slorber Nov 17, 2021

Josh-Cena Nov 17, 2021

Josh-Cena commented Nov 17, 2021

slorber commented Nov 17, 2021 •

edited

Loading

Josh-Cena commented Nov 18, 2021 •

edited

Loading

slorber left a comment

feat(core): allow sourcing from multiple static directories #4095

feat(core): allow sourcing from multiple static directories #4095

Conversation

oriooctopus commented Jan 24, 2021

netlify bot commented Jan 24, 2021

github-actions bot commented Jan 24, 2021

netlify bot commented Jan 24, 2021 • edited Loading

github-actions bot commented Jan 24, 2021 • edited Loading

slorber left a comment

Choose a reason for hiding this comment

This comment has been minimized.

slorber left a comment

Choose a reason for hiding this comment

slorber Nov 17, 2021

Choose a reason for hiding this comment

Josh-Cena Nov 17, 2021

Choose a reason for hiding this comment

Josh-Cena commented Nov 17, 2021

slorber commented Nov 17, 2021 • edited Loading

Josh-Cena commented Nov 18, 2021 • edited Loading

slorber left a comment

Choose a reason for hiding this comment

netlify bot commented Jan 24, 2021 •

edited

Loading

github-actions bot commented Jan 24, 2021 •

edited

Loading

slorber commented Nov 17, 2021 •

edited

Loading

Josh-Cena commented Nov 18, 2021 •

edited

Loading