https://github.com/matchilling/org.programmingtalks
https://github.com/matchilling/org.programmingtalks
Last synced: 24 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/matchilling/org.programmingtalks
- Owner: matchilling
- Created: 2018-03-05T17:43:56.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-03-05T18:11:30.000Z (over 8 years ago)
- Last Synced: 2025-10-28T01:34:08.268Z (9 months ago)
- Language: JavaScript
- Size: 3.69 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Preact Documentation Website
[](https://travis-ci.org/developit/preact-www)
[](https://gitter.im/developit/preact)
Based on [preact-boilerplate](https://github.com/developit/preact-boilerplate)
> :rocket: `master` is automatically deployed to [preactjs.com](https://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
```sh
git clone https://github.com/developit/preact-www.git
cd preact-www
npm install
```
## Development Workflow
**To start a live-reload development server:**
```sh
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`:**
```sh
npm run build
```
---
## License
MIT
[marked]: https://github.com/chjj/marked
[preact]: https://github.com/developit/preact
[preact-markup]: https://github.com/developit/preact-markup