Add documentation theme

Spaghetti-Dojo · Feb 24, 2024 · ca48137 · ca48137
1 parent 69f341c
commit ca48137
Show file tree

Hide file tree

Showing 10 changed files with 69 additions and 1 deletion.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,15 @@
+title: Wp Entities Search
+description: >-
+  A WordPress package to search Entities including Rest API Endpoints and React Components
+url: 'https://widoz.github.io/wp-entities-search'
+baseurl: '/wp-entities-search'
+
+remote_theme: just-the-docs/just-the-docs
+
+toc:
+  enabled: true
+  h_min: 1
+  h_max: 3
+
+plugins:
+  - jekyll-remote-theme
diff --git a/docs/api.md b/docs/api.md
@@ -1,3 +1,9 @@
+---
+title: Api
+layout: post
+nav_order: 1
+---
+
 # Api
 
 The `api` define a `fetch` function which is there to hide the WordPress Fetch API. The reason behind this decision lies on the fact that we might want to add middlewares to the request in the future or introducing some global data manipulation.

diff --git a/docs/components.md b/docs/components.md
@@ -1,3 +1,9 @@
+---
+title: Components
+layout: post
+nav_order: 2
+---
+
 # Components
 
 The Wp Entities Search provides a set of components you can use to build your search UI.

diff --git a/docs/control-option.md b/docs/control-option.md
@@ -1,3 +1,9 @@
+---
+title: Control Option
+layout: post
+nav_order: 3
+---
+
 # Control Option
 
 The `ControlOption` is the core Value Object of the project. It holds the information about the entities, and it

diff --git a/docs/development.md b/docs/development.md
@@ -1,3 +1,9 @@
+---
+title: Development
+layout: post
+nav_order: 4
+---
+
 # Development
 
 The first thing to do is to clone the repository and install the dependencies:

diff --git a/docs/hooks.md b/docs/hooks.md
@@ -1,3 +1,9 @@
+---
+title: Hooks
+layout: post
+nav_order: 5
+---
+
 # Hooks
 
 The Wp Entities Search expose some hooks to help you to work with the search and the rest calls.

diff --git a/docs/installation.md b/docs/installation.md
@@ -1,3 +1,9 @@
+---
+title: Installation
+layout: post
+nav_order: 6
+---
+
 # Installation
 
 This package is available as a composer library and as a npm package.

diff --git a/docs/logging.md b/docs/logging.md
@@ -1,3 +1,9 @@
+---
+title: Logging
+layout: post
+nav_order: 7
+---
+
 # Logging
 
 The project make use of some WordPress Actions in contexts where the logic flow might fail for some reason, for instance

diff --git a/docs/readme.md b/docs/readme.md
@@ -1,4 +1,9 @@
-# Wp Entities Search
+---
+layout: home
+title: Wp Entities Search
+permalink: /
+nav_order: 0
+---
 
 This package is a library exposing reusable Components and Utilities to help you build Entities searching and storage.
 

diff --git a/docs/storage.md b/docs/storage.md
@@ -1,3 +1,9 @@
+---
+title: Storage
+layout: post
+nav_order: 8
+---
+
 # Storage
 
 You won't interact directly with the store but as mentioned in [hooks](./hooks.md), you can use the `useEntitiesOptionsStorage`.