Skip to content
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
Binary file added docs/assets/favicon.ico
Binary file not shown.
12 changes: 11 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# pg_crdt
# Introduction

`pg_crdt` is an experimental extension adding support for
conflict-free replicated data types (CRDTs) in Postgres.

## What is a a CRDT?

CRDTs are decentralized data structures that can safely be replicated
and synchronized across multiple computers/nodes. They are the
enabling technology for collaborative editing applications like
[Notion](https://www.notion.so).
20 changes: 20 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
@import url("https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:ital,wght@0,100;0,200;0,300;0,400;0,500;0,600;0,700;1,100;1,200;1,300;1,400;1,500;1,600;1,700&display=swap");

:root {
--md-text-font: "IBM Plex Sans", "Roboto", sans-serif;
/* color: red; */
}

[data-md-color-scheme="slate"] {
--md-default-bg-color: #121212;
--md-default-fg-color--light: white;
--md-code-bg-color: #2a2929;
--md-code-hl-keyword-color: #569cd6;
}

.md-header,
.md-tabs {
background-color: var(--md-default-bg-color);
color: var(--md-default-fg-color--light);
font-family: var(--md-text-font);
}
29 changes: 28 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,32 @@
site_name: "pg_crdt"
docs_dir: docs
site_dir: site
site_url: https://supabase.github.io/pg_crdt
site_description: A PostgreSQL extension for CRDTs
copyright: Copyright © Supabase
repo_name: supabase/pg_crdt
repo_url: https://github.com/supabase/pg_crdt

theme:
name: mkdocs
name: "material"
favicon: "assets/favicon.ico"
logo: "assets/favicon.ico"
palette:
scheme: slate
primary: green
accent: green

extra_css:
- stylesheets/extra.css

extra:
social:
- icon: fontawesome/brands/twitter
link: https://x.com/supabase
name: Supabase on Twitter
- icon: fontawesome/brands/reddit
link: https://reddit.com/r/supabase
name: Supabase on Reddit
- icon: fontawesome/brands/github
link: https://github.com/supabase/pg_crdt
name: pg_crdt on GitHub
14 changes: 14 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
[project]
name = "pg-crdt"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"mkdocs>=1.6.1",
"mkdocs-material>=9.6.11",
]

[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
Loading
Loading