https://github.com/polyphony-chat/polyproto-dot-org
A dedicated website housing the polyproto specifications and everything polyproto related.
https://github.com/polyphony-chat/polyproto-dot-org
docusaurus polyproto polyproto-core react typescript typescript-react yarn
Last synced: about 1 month ago
JSON representation
A dedicated website housing the polyproto specifications and everything polyproto related.
- Host: GitHub
- URL: https://github.com/polyphony-chat/polyproto-dot-org
- Owner: polyphony-chat
- License: mpl-2.0
- Created: 2025-03-26T17:16:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-15T17:24:17.000Z (10 months ago)
- Last Synced: 2025-08-15T19:30:11.900Z (10 months ago)
- Topics: docusaurus, polyproto, polyproto-core, react, typescript, typescript-react, yarn
- Language: TypeScript
- Homepage: https://polyproto.org
- Size: 4.52 MB
- Stars: 3
- Watchers: 2
- Forks: 9
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!IMPORTANT]
> 📦️ We moved! Come check out our new place over on [Codeberg](https://codeberg.org/polyphony)! ([Repository link](https://codeberg.org/polyphony/polyproto-dot-org))
>
> We have moved to [Codeberg](https://codeberg.org/polyphony) as our primary Git Forge, and the project is *alive and well* over there! :purple_heart: The GitHub repositories will be archived and potentially deleted in the future.
Old README (outdated!)
[![FAQ-shield]][FAQ]
# Website
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
## Installation
```bash
yarn
```
### Pre-commit Hooks
This project uses pre-commit hooks to ensure code quality and uniform formatting. To set up
pre-commit hooks:
1. Install pre-commit:
```bash
pip install pre-commit
```
2. Install prettier and dev-dependencies:
```bash
yarn install
```
3. Install the git hooks:
```bash
pre-commit install
```
The pre-commit hooks will automatically:
- Format Markdown and MDX files using Prettier
- Lint Markdown files using markdownlint
- Check for common issues like trailing whitespace and file endings
You can manually run the checks on all files:
```bash
pre-commit run --all-files
```
### Local Development
```bash
yarn start
```
This command starts a local development server and opens up a browser window. Most changes are
reflected live without having to restart the server.
### Build
```bash
yarn build
```
This command generates static content into the `build` directory and can be served using any static
contents hosting service.
[FAQ-shield]: https://img.shields.io/badge/Frequently_Asked_Questions_(FAQ)-ff62bd
[FAQ]: https://github.com/polyphony-chat/.github/blob/main/FAQ.md