Beanz/pdf.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update the "File Layout Overview" docs

Browse Source 
Apparently we forgot to update this in the version 4 release, so better late than never I suppose.
 - Use `.mjs` extensions where appropriate.
 - Remove mention of the `debugger`-functionality, since that's not really relevant to users.
 - Unify the whitespace handling to use spaces consistently.
This commit is contained in:
Jonas Jenwald 2024-05-24 11:42:06 +02:00
parent 08bf96865d
commit 03601f99d8
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/contents/getting_started/index.md
View File

@ -78,20 +78,19 @@ Note that we only mention the most relevant files and folders.
``` ```
├── build/ ├── build/
│   ├── pdf.js - display layer │ ├── pdf.mjs - display layer
│   ├── pdf.js.map - display layer's source map │ ├── pdf.mjs.map - display layer's source map
│   ├── pdf.worker.js - core layer │ ├── pdf.worker.mjs - core layer
│   └── pdf.worker.js.map - core layer's source map │ └── pdf.worker.mjs.map - core layer's source map
├── web/ ├── web/
│ ├── cmaps/ - character maps (required by core) │ ├── cmaps/ - character maps (required by core)
│ ├── compressed.tracemonkey-pldi-09.pdf - PDF file for testing purposes │ ├── compressed.tracemonkey-pldi-09.pdf - PDF file for testing purposes
│ ├── debugger.js - helpful debugging features
│ ├── images/ - images for the viewer and annotation icons │ ├── images/ - images for the viewer and annotation icons
│ ├── locale/ - translation files │ ├── locale/ - translation files
│ ├── viewer.css - viewer style sheet │ ├── viewer.css - viewer style sheet
│ ├── viewer.html - viewer layout │ ├── viewer.html - viewer layout
│ ├── viewer.js - viewer layer │ ├── viewer.mjs - viewer layer
│ └── viewer.js.map - viewer layer's source map │ └── viewer.mjs.map - viewer layer's source map
└── LICENSE └── LICENSE
``` ```
@ -104,16 +103,16 @@ Note that we only mention the most relevant files and folders.
├── external/ - third party code ├── external/ - third party code
├── l10n/ - translation files ├── l10n/ - translation files
├── src/ ├── src/
│   ├── core/ - core layer │ ├── core/ - core layer
│   ├── display/ - display layer │ ├── display/ - display layer
│   ├── shared/ - shared code between the core and display layers │ ├── shared/ - shared code between the core and display layers
│   ├── interfaces.js - interface definitions for the core/display layers │ ├── interfaces.js - interface definitions for the core/display layers
│   └── pdf.*.js - wrapper files for bundling │ └── pdf.*.js - wrapper files for bundling
├── test/ - unit, font, reference, and integration tests ├── test/ - unit, font, reference, and integration tests
├── web/ - viewer layer ├── web/ - viewer layer
├── LICENSE ├── LICENSE
├── README.md ├── README.md
├── gulpfile.js - build scripts/logic ├── gulpfile.mjs - build scripts/logic
├── package-lock.json - pinned dependency versions ├── package-lock.json - pinned dependency versions
└── package.json - package definition and dependencies └── package.json - package definition and dependencies
``` ```