docs: add coming soon API guide

FlorianWoelki · Aug 13, 2024 · ec86a81 · ec86a81
1 parent 5eb5ee9
commit ec86a81
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -11,6 +11,7 @@ export default defineConfig({
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Get Started', link: '/guide/getting-started' },
+      { text: 'API', link: '/api/getting-started' },
     ],
 
     search: {
@@ -56,6 +57,11 @@ export default defineConfig({
           { text: 'Icon above Title', link: '/notes/title-icon' },
         ],
       },
+      {
+        text: 'API',
+        collapsed: false,
+        items: [{ text: 'Getting Started', link: '/api/getting-started' }],
+      },
       {
         text: 'Compatibility with Plugins',
         collapsed: true,

diff --git a/docs/api/getting-started.md b/docs/api/getting-started.md
@@ -0,0 +1,11 @@
+---
+title: API Getting Started | Obsidian Iconize
+---
+
+# Getting Started
+
+*Coming Soon*
+
+## What is possible?
+
+## Installation
diff --git a/docs/index.md b/docs/index.md
@@ -10,6 +10,9 @@ hero:
     - theme: brand
       text: Get Started
       link: /guide/getting-started
+    - theme: brand
+      text: API
+      link: /api/getting-started
     - theme: alt
       text: Files and Folders
       link: /files-and-folders/icon-before-file-or-folder
@@ -25,4 +28,3 @@ features:
   - title: Community Driven
     details: The plugin is open source and everyone can contribute bug reports, features, or ideas to it.
 ---
-