Skip to content

Latest commit

 

History

History
78 lines (41 loc) · 1.84 KB

README.md

File metadata and controls

78 lines (41 loc) · 1.84 KB
Raw

Preact Documentation Website

Build Status gitter

Based on preact-boilerplate

🚀 master is automatically deployed to preactjs.com

Application Structure

This website is built as a static-app, following the Application Shell pattern.

Content

Content is fetched and rendered on the fly from Markdown documents located in content/. Documents can contain optional YAML FrontMatter for specifying page metadata or layout information. Once fetched, content is parsed using marked and rendered to VDOM via preact-markup.

Custom Elements

Since preact is used to render the Markdown content, HTML contained in a document reference any of the Components listed in src/components/widget.js as Custom Elements, useful for dynamic content.

Navigation

Currently, the navigation menu and route handling is controlled by src/config.json. This is likely to change, but in the meantime it means any new pages must be linked from the "nav" section of the config.

Local Development

Clone & Install Dependencies

git clone https://github.com/developit/preact-www.git
cd preact-www

npm install

Development Workflow

To start a live-reload development server:

PORT=8080 npm run dev

Any time you make changes within the src directory, it will rebuild and even refresh your browser.

Generate a production build in ./build:

npm run build

License

MIT