docs: brand (#91)

- new logo
- new branch color
- updated docs for bundle size,  fixes #89
- distribute license

.github/workflows/publish.yml

@@ -21,7 +21,10 @@ jobs:
       - name: Build
         run: npm run build --workspace=pure-parse
       - name: Copy README into the workspace
-        run: cp README.md packages/pure-parse/
+        run: |
+          cp README.md packages/pure-parse/
+          cp logo.webp packages/pure-parse/
+          cp LICENSE packages/pure-parse/
       - name: Publish to NPM
         run: npm publish --access public --workspace=pure-parse
         env:

README.md

@@ -1,8 +1,9 @@
 <div align="center">
+  <img src="logo.webp" width="200px" align="center" alt="PureParse logo" />  
   <h1 align="center">PureParse</h1>
   <h3>Typesafe, lightweight parsers</h3>
   <p align="center">
-    Lightweight validation library that decouples type aliases from validation logic
+    Strongly typed validation library that decouples type aliases from validation logic
   </p>
   <p align="center">
     <a href="https://pure-parse.vercel.app">Documentation</a>

packages/pure-parse/.vitepress/config.ts

@@ -4,9 +4,12 @@ import typedocSidebar from '../docs/api/typedoc-sidebar.json'
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: 'PureParse',
+  head: [['link', { rel: 'icon', href: '/logo.webp' }]],
+
   description: 'Derive parsers from types',
   srcDir: 'docs',
   themeConfig: {
+    logo: '/logo.webp',
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },

packages/pure-parse/.vitepress/theme/index.ts

@@ -0,0 +1,4 @@
+import DefaultTheme from 'vitepress/theme'
+import './styles.css'
+
+export default DefaultTheme

packages/pure-parse/.vitepress/theme/styles.css

@@ -0,0 +1,19 @@
+:root {
+  --pp-1: #3d9efe;
+  --pp-3: #2b7df5;
+  --pp-5: #266be9;
+
+  --vp-c-brand-1: var(--pp-5);
+  --vp-c-brand-2: var(--pp-5);
+  --vp-c-brand-3: var(--pp-1);
+
+  --vp-home-hero-name-color: var(--pp-1);
+}
+
+.dark {
+  --vp-c-brand-1: var(--pp-1);
+  --vp-c-brand-2: var(--pp-3);
+  --vp-c-brand-3: var(--pp-5);
+
+  --vp-home-hero-name-color: var(--pp-1);
+}

packages/pure-parse/docs/guide/comparison.md

@@ -58,7 +58,7 @@ _Safe parsing_ means that a copy of the parsed data is returned, which contains
 
 | Library                                               | Minified + Zipped |
 | ----------------------------------------------------- | ----------------- |
-| [PureParse](https://www.npmjs.com/package/pure-parse) | 3 kB              |
+| [PureParse](https://www.npmjs.com/package/pure-parse) | 5 kB              |
 | [Zod](https://www.npmjs.com/package/zod)              | 21 kB             |
 | [Joi](https://www.npmjs.com/package/joi)              | 236 kB            |
 | [Ajv](https://www.npmjs.com/package/ajv)              | 32 kB             |

packages/pure-parse/docs/index.md

@@ -4,7 +4,7 @@ layout: home
 hero:
   name: PureParse
   text: Typesafe, lightweight parsers
-  tagline: Lightweight validation library that decouples type aliases from validation logic
+  tagline: Strongly typed validation library that decouples type aliases from validation logic
   actions:
     - theme: brand
       text: Quick Start
@@ -18,22 +18,26 @@ hero:
 features:
   - title: Lightweight
     icon:
-      src: /feather.svg
-    details: 0 dependencies, tree-shakeable, and less than 3 kB gzipped.
+      light: /feather-light.svg
+      dark: /feather-dark.svg
+    details: 0 dependencies, 5 kB gzipped, and fully tree-shakeable.
     link: /guide/overview#lightweight
   - title: Easy to use
     icon:
-      src: /block.svg
+      light: /block-light.svg
+      dark: /block-dark.svg
     details: Compose and customize with ease.
     link: /guide/overview#extensible-and-easy-to-use
   - title: Fast
     icon:
-      src: /guage.svg
+      light: /guage-light.svg
+      dark: /guage-dark.svg
     details: Among the fastest validators. Memoize for even better performance.
     link: /guide/overview#fast
   - title: Fail-safe
     icon:
-      src: /shield.svg
+      light: /shield-light.svg
+      dark: /shield-dark.svg
     details: Recover from errors gracefully when parsing large documents.
     link: /guide/overview#fail-safe
 ---

packages/pure-parse/package.json

@@ -1,8 +1,8 @@
 {
   "name": "pure-parse",
-  "version": "0.0.0-beta.5",
+  "version": "0.0.0-beta.6",
   "private": false,
-  "description": "Lightweight validation library that decouples type aliases from validation logic",
+  "description": "Strongly typed validation library that decouples type aliases from validation logic",
   "author": {
     "name": "Johannes Lindgren"
   },
@@ -25,7 +25,8 @@
   "license": "MIT",
   "sideEffects": false,
   "files": [
-    "dist"
+    "dist",
+    "logo.webp"
   ],
   "type": "module",
   "module": "./dist/index.js",