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.

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

chore: Remove travis config & changelog, touch-up readme #1033

Merged
merged 1 commit into from
Dec 3, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 0 additions & 13 deletions .travis.yml

This file was deleted.

64 changes: 0 additions & 64 deletions CHANGELOG.md

This file was deleted.

15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Preact Documentation Website

[![Build Status](https://travis-ci.org/preactjs/preact-www.svg?branch=master)](https://travis-ci.org/preactjs/preact-www)
[![Preact Slack Community](https://img.shields.io/badge/slack-Preact%20Slack%20Community-blue?logo=slack)](https://chat.preactjs.com/)

Built with [preact-cli](https://github.com/preactjs/preact-cli)
Expand All @@ -9,17 +8,17 @@ Built with [preact-cli](https://github.com/preactjs/preact-cli)

---

# Application Structure
## Application Structure

This website is built as a [prerendered static app](https://developers.google.com/web/updates/2019/02/rendering-on-the-web#static-rendering), following the [Application Shell pattern](https://developers.google.com/web/fundamentals/architecture/app-shell).

#### Content
### Content

Content is fetched and rendered on the fly from Markdown documents located in `content/`, similar to how Jekyll works.
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
### 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:

Expand All @@ -32,14 +31,14 @@ Since [preact] is used to render the Markdown content, HTML contained in a docum
</jumbotron>
```

#### Navigation
### 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
## Local Development

### Clone & Install Dependencies

Expand All @@ -50,12 +49,12 @@ cd preact-www
npm install
```

## Development Workflow
### Development Workflow

**To start a live-reload development server:**

```sh
PORT=8080 npm run dev
npm run dev
```

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