-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
65 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { FC, PropsWithChildren } from "react"; | ||
|
||
export const KeyPoint: FC<PropsWithChildren<{ title: string }>> = ({ | ||
title, | ||
children, | ||
}) => ( | ||
<div className="w-full border rounded border-gray-500 p-4 text-left"> | ||
<div className="text-[--vocs-color_heading] text-lg py-2 font-bold"> | ||
{title} | ||
</div> | ||
<div>{children}</div> | ||
</div> | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,48 @@ | ||
--- | ||
layout: landing | ||
content: | ||
width: 60rem | ||
--- | ||
|
||
import { HomePage } from 'vocs/components' | ||
import { KeyPoint } from './KeyPoint'; | ||
|
||
<HomePage.Root> | ||
<HomePage.Logo /> | ||
<HomePage.InstallPackage name="papee" type="i" /> | ||
<HomePage.Description>Typescript API to interact with polkadot chains.</HomePage.Description> | ||
<HomePage.Buttons> | ||
<HomePage.Button href="/getting-started" variant="accent">Get started</HomePage.Button> | ||
<HomePage.Button href="https://github.com/polkadot-api/polkadot-api">GitHub</HomePage.Button> | ||
</HomePage.Buttons> | ||
<HomePage.Root style={{}}> | ||
<div className="flex justify-between w-full flex-col md:flex-row gap-4"> | ||
<div className="flex flex-col text-left"> | ||
<HomePage.Logo /> | ||
<HomePage.Description>Typescript API to interact with polkadot chains.</HomePage.Description> | ||
<HomePage.Buttons className="py-2"> | ||
<HomePage.Button href="/getting-started" variant="accent">Get started</HomePage.Button> | ||
<HomePage.Button href="https://github.com/polkadot-api/polkadot-api">GitHub</HomePage.Button> | ||
</HomePage.Buttons> | ||
</div> | ||
|
||
<HomePage.InstallPackage name="papee" type="i" /> | ||
</div> | ||
|
||
<div className="flex gap-2 flex-col md:flex-row mt-8"> | ||
<KeyPoint title="Light client first"> | ||
Built from the ground up for the light client, allowing running a node from the browser. | ||
</KeyPoint> | ||
<KeyPoint title="Full typed API"> | ||
IDEs show all the type information for every operation of a chain. | ||
</KeyPoint> | ||
<KeyPoint title="Lightweight"> | ||
Minimal impact on the main bundle (under 50kB) | ||
</KeyPoint> | ||
</div> | ||
|
||
<div className="text-left w-full max-w-2xl p-2"> | ||
<h2 className="text-[--vocs-color_heading] text-3xl py-4 border-b border-gray-500 mb-4">Features</h2> | ||
<ul className="list-disc pl-5"> | ||
<li>Connect to the chain through a light client or a WebSocket connection</li> | ||
<li>Perform storage queries or runtime calls</li> | ||
<li>Generate the types of a chain through its current metadata</li> | ||
<li>Compatibility checks</li> | ||
<li>Multiple connections to different chains</li> | ||
<li>Transaction API in read-only and read/write mode</li> | ||
<li>Promise-based or Observable-based API for your needs</li> | ||
</ul> | ||
</div> | ||
</HomePage.Root> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
@layer vocs_preflight { @tailwind base; } | ||
@tailwind components; | ||
@tailwind utilities; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
/** @type {import('tailwindcss').Config} */ | ||
module.exports = { | ||
content: ["./docs/**/*.{html,md,mdx,tsx,js,jsx}"], | ||
theme: { | ||
extend: {}, | ||
}, | ||
plugins: [], | ||
}; |