Getting Started
This page covers getting the source and previewing the landing page and any example locally.
Prerequisites
| Item | Description |
|---|---|
| Browser | Any modern browser with ES Module support (Chrome, Safari, Firefox, Edge) |
| HTTP static server | The landing page reads the catalog via fetch('./README.md'), which fails under file://; example pages open directly from disk |
| Network | Examples load PDRenderKit and Font Awesome from cdn.jsdelivr.net and fonts from fonts.googleapis.com |
| Dart Sass (optional) | Needed only to change styles, run through Node.js npx sass |
Get the Source
git clone https://github.com/pardnio/demo-web.git
cd demo-web
Local Preview
python3 -m http.server 8080 || { echo "port 8080 is in use"; exit 1; }
| URL | Content |
|---|---|
http://localhost:8080/ |
Landing page: README.md example gallery rendered by PDMarkdownKit |
http://localhost:8080/target/20241220/ |
A single example (folder name is the creation date) |
Online
- GitHub Pages: https://pardnio.github.io/demo-web/
- Every example page on this documentation site embeds a live view of that example, served from a copy of the repo's
target/directory.
Next Steps
- Project Structure: folder naming and what each example contains
- Styling Workflow: how to recompile SCSS