Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update the "File Layout Overview" docs #18160

Merged
merged 1 commit into from
May 24, 2024
Merged

Update the "File Layout Overview" docs #18160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions docs/contents/getting_started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,20 +78,19 @@ Note that we only mention the most relevant files and folders.

```
├── build/
│   ├── pdf.js - display layer
│   ├── pdf.js.map - display layer's source map
│   ├── pdf.worker.js - core layer
│   └── pdf.worker.js.map - core layer's source map
│ ├── pdf.mjs - display layer
│ ├── pdf.mjs.map - display layer's source map
│ ├── pdf.worker.mjs - core layer
│ └── pdf.worker.mjs.map - core layer's source map
├── web/
│ ├── cmaps/ - character maps (required by core)
│ ├── compressed.tracemonkey-pldi-09.pdf - PDF file for testing purposes
│ ├── debugger.js - helpful debugging features
│ ├── images/ - images for the viewer and annotation icons
│ ├── locale/ - translation files
│ ├── viewer.css - viewer style sheet
│ ├── viewer.html - viewer layout
│ ├── viewer.js - viewer layer
│ └── viewer.js.map - viewer layer's source map
│ ├── viewer.mjs - viewer layer
│ └── viewer.mjs.map - viewer layer's source map
└── LICENSE
```

Expand All @@ -104,16 +103,16 @@ Note that we only mention the most relevant files and folders.
├── external/ - third party code
├── l10n/ - translation files
├── src/
│   ├── core/ - core layer
│   ├── display/ - display layer
│   ├── shared/ - shared code between the core and display layers
│   ├── interfaces.js - interface definitions for the core/display layers
│   └── pdf.*.js - wrapper files for bundling
│ ├── core/ - core layer
│ ├── display/ - display layer
│ ├── shared/ - shared code between the core and display layers
│ ├── interfaces.js - interface definitions for the core/display layers
│ └── pdf.*.js - wrapper files for bundling
├── test/ - unit, font, reference, and integration tests
├── web/ - viewer layer
├── LICENSE
├── README.md
├── gulpfile.js - build scripts/logic
├── gulpfile.mjs - build scripts/logic
├── package-lock.json - pinned dependency versions
└── package.json - package definition and dependencies
```
Expand Down