Public Files
Overview
Below is an index of PDF documents stored under /static/files and served from /files/*.
All files here are intended for public distribution (no internal secrets). Before adding a file:
- Prefer clear, descriptive filenames (e.g.
electrical-bible-v2.pdf). - Avoid spaces if possible; if spaces are needed, links must URL-encode them (
%20). - Ensure PDFs are trimmed (no blank trailing pages) and under a reasonable size (< 25MB ideal).
- Redact any personal information or student data before publishing.
Current Files
| File | Direct Link | Notes |
|---|---|---|
| UPDATED Electrical Bible | /files/UPDATED%20Electrical%20Bible.pdf | Electrical reference handbook (updated). |
Adding New Files
- Place the PDF in
static/files/. - Regenerate filename if it contains spaces (optional but recommended).
- Add a new table row above maintaining alphabetical order.
- Commit changes; no build step needed beyond standard Docusaurus build.
Embedding Examples
You can embed a PDF inline using the basic iframe viewer or the advanced canvas viewer.
Inline Viewer (Canvas)
Using the internal canvas-based viewer prevents the browser from auto-triggering a download. If the file is missing you will see an error message.
Simple Link
If you only need a link (will respect user browser PDF handling):
/files/UPDATED%20Electrical%20Bible.pdf
For more embedding patterns see the PDF Viewer Demo.
License & Distribution
Unless otherwise noted inside a document, Team2180 grants usage under the terms defined in usage-license.
For external sharing (social media, outreach, other teams) link directly to the hosted file. Do not re-host modified copies without clearly marking changes.
Roadmap
- Add automatic file metadata extraction (size, last updated) via a small script.
- Optional version tagging (e.g.
electrical-bible-v3.pdf). - Integrate full-text search index if documents are converted to HTML.
If you need to remove a file, delete it from static/files/ and update this index. Build output will drop it automatically.