-
Notifications
You must be signed in to change notification settings - Fork 4
add pictures for module theory #66
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
Merged
awxiaoxian2020
merged 6 commits into
ts-zh-docs:main
from
hanyujie2002:module_theory_pics
Jun 15, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
94966cb
add pictures for module theory
hanyujie2002 2650d3d
fix
hanyujie2002 c5cd0a5
Merge branch 'main' into module_theory_pics
awxiaoxian2020 3ccb993
Merge branch 'main' into module_theory_pics
awxiaoxian2020 a2f5062
Merge branch 'main' into module_theory_pics
awxiaoxian2020 4c9a19a
Merge branch 'main' into module_theory_pics
awxiaoxian2020 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
Some of this content uses mermaid diagrams. We could render them as part of the website build with gatsby-remark-mermaid, but that requires puppeteer/Chromium, which has historically caused a lot of cross-platform build issues. These diagrams should not change often, so I’m just going to store the source here and generate the SVGs manually. | ||
|
||
Example: | ||
|
||
```sh | ||
npm install -g @mermaid-js/mermaid-cli | ||
cd packages/documentation/copy/en/modules-reference/diagrams | ||
mmdc -c mermaid.config.json -i esm-cjs-interop.md | ||
``` | ||
|
||
declaration-files.svg is a non-Mermaid replacement for theory.md-4.svg. I made it for a talk one time and it’s better than what Mermaid can do with a flowchart. |
17 changes: 17 additions & 0 deletions
17
docs/documentation/zh/modules-reference/diagrams/declaration-files.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions
26
docs/documentation/zh/modules-reference/diagrams/esm-cjs-interop.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
```mermaid | ||
graph TB | ||
subgraph Transpiled[ESM transpiled to CJS] | ||
direction TB | ||
C[Importing module] -- designed based on spec --> D[Imported module] | ||
end | ||
subgraph ESM | ||
direction TB | ||
A[Importing module] -- specified behavior --> B[Imported module] | ||
end | ||
``` | ||
|
||
```mermaid | ||
graph TD | ||
subgraph Transpiled[ESM transpiled to CJS] | ||
C[Importing module] -- designed based on spec --> D[Imported module] | ||
end | ||
subgraph CJS[True CJS] | ||
E[Imported module] | ||
end | ||
subgraph ESM | ||
A[Importing module] -- specified behavior --> B[Imported module] | ||
end | ||
A -. unspecified behavior .-> E | ||
C .->|"<span style='font-size: 3em'>❓🤷🏻♂️❓</span>"| E | ||
``` |
1 change: 1 addition & 0 deletions
1
docs/documentation/zh/modules-reference/diagrams/esm-cjs-interop.md-1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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 tells us we need "permalink".
Could we add this folder in Localization site?
Ping @orta politely to get some ideas :)