chore: update docs

grapp-dev · Apr 11, 2024 · 9105fc5 · 9105fc5
1 parent 9618abc
commit 9105fc5
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 41 deletions.
diff --git a/docs/bun.lockb b/docs/bun.lockb
diff --git a/docs/package.json b/docs/package.json
@@ -20,6 +20,6 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
-    "@grapp/nextra-theme": "^0.3.2"
+    "@grapp/nextra-theme": "^0.3.8"
   }
 }
diff --git a/docs/pages/_meta.json b/docs/pages/_meta.json
@@ -17,11 +17,5 @@
     "theme": {
       "typesetting": "article"
     }
-  },
-  "sponsor_link": {
-    "type": "page",
-    "title": "Sponsor ↗",
-    "href": "https://github.com/sponsors/mobily",
-    "newWindow": true
   }
 }
diff --git a/docs/pages/docs/_meta.json b/docs/pages/docs/_meta.json
@@ -14,6 +14,11 @@
     "title": "More"
   },
   "showcase": "",
+  "sponsor_link": {
+    "title": "Sponsor ↗",
+    "href": "https://github.com/sponsors/mobily",
+    "newWindow": true
+  },
   "github_link": {
     "title": "GitHub ↗",
     "href": "https://github.com/grapp-dev/nui-components.nvim",

diff --git a/docs/pages/docs/getting-started.mdx b/docs/pages/docs/getting-started.mdx
@@ -1,9 +1,11 @@
+import { Tabs } from 'nextra/components'
+
 ## Installation
 
 To install NuiComponents, you should use your preferred plugin manager.
 
-[Lazy](https://github.com/folke/lazy.nvim)
-
+<Tabs items={['Lazy', 'Packer']}>
+<Tabs.Tab>
 ```lua
 {
   "grapp-dev/nui-components.nvim",
@@ -12,9 +14,8 @@ To install NuiComponents, you should use your preferred plugin manager.
   }
 }
 ```
-
-[Packer](https://github.com/wbthomason/packer.nvim)
-
+</Tabs.Tab>
+<Tabs.Tab>
 ```lua
 use {
   "grapp-dev/nui-components.nvim",
@@ -23,6 +24,8 @@ use {
   }
 }
 ```
+</Tabs.Tab>
+</Tabs>
 
 ## Your first UI implementation
 

diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -20,29 +20,28 @@ import { Homepage, Hero, Features, Feature } from '@grapp/nextra-theme';
       }
     />
   }
-  features={
-    <Features>
-      <Feature
-        title="Reactive UI"
-        description="The library automatically handles UI updates based on input and events received."
-      />
-      <Feature
-        title="Flexbox"
-        description="NuiComponents supports a simple flexbox layout system, which provides a more flexible way to layout UIs."
-      />
-      <Feature
-        title="State Management"
-        description="The library provides a state management system that allows managing data and UI state with ease."
-      />
+>
+  <Features>
+    <Feature
+      title="Reactive UI"
+      description="The library automatically handles UI updates based on input and events received."
+    />
+    <Feature
+      title="Flexbox"
+      description="NuiComponents supports a simple flexbox layout system, which provides a more flexible way to layout UIs."
+    />
+    <Feature
+      title="State Management"
+      description="The library provides a state management system that allows managing data and UI state with ease."
+    />
 
-      <Feature
-        title="Extensibility"
-        description="Create your custom components by using Component API."
-      />
-      <Feature
-        title="Reusability"
-        description="Reuse components between different parts of UI, reduce the amount of code you need to write."
-      />
-    </Features>
-  }
-/>
+    <Feature
+      title="Extensibility"
+      description="Create your custom components by using Component API."
+    />
+    <Feature
+      title="Reusability"
+      description="Reuse components between different parts of UI, reduce the amount of code you need to write."
+    />
+  </Features>
+</Homepage>
diff --git a/docs/theme.config.jsx b/docs/theme.config.jsx
@@ -11,12 +11,11 @@ export default getDefaultConfig({
   discord: 'https://discord.gg/Rj2V3keVS4',
   docs: 'https://nui-components.grapp.dev',
   logo: () => {
-    return <Logo image={NuiComponentsLogo} title="Nui.Components" />;
+    return <Logo image={NuiComponentsLogo} title="nui-components.nvim" />;
   },
   footer: () => {
     return (
       <Footer
-        github="https://github.com/grapp-dev/nui-components.nvim"
         sections={[
           {
             title: 'FAQ',

diff --git a/docs/tsconfig.json b/docs/tsconfig.json
@@ -1,8 +1,11 @@
 {
-  "extends": "@grapp/nextra-theme/default.json",
+  "extends": "@grapp/nextra-theme/tsconfig.json",
   "include": [
     "next-env.d.ts",
     "./docs/**/*.ts",
     "./docs/**/*.tsx"
-  ]
+  ],
+  "compilerOptions": {
+    "incremental": true
+  }
 }