diff --git a/README.md b/README.md index 2b5acfa..278dee7 100644 --- a/README.md +++ b/README.md @@ -37,4 +37,10 @@ To build the static website: mkdocs build ``` -This will create a `site` directory with your static documentation website ready to be hosted. \ No newline at end of file +This will create a `site` directory with your static documentation website ready to be hosted. + +### Notes +1. Use relative links for internal navigation. + +> Example: + You can find out more examples at `[inteliver Examples](../examples/index.md)` \ No newline at end of file diff --git a/docs/examples/crop.md b/docs/examples/crop.md index 000b95a..1bba4d7 100644 --- a/docs/examples/crop.md +++ b/docs/examples/crop.md @@ -60,7 +60,7 @@ i_c_object_person,i_h_200,i_w_200,i_o_crop /000931783192390000000000000000000704.jpeg) !!! info - You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images. + You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images. #### Round Crop diff --git a/docs/examples/operation.md b/docs/examples/operation.md index 2db3f14..90edb0a 100644 --- a/docs/examples/operation.md +++ b/docs/examples/operation.md @@ -9,19 +9,19 @@ weight: 2 Modify your image data using a variety of image processing functions. These functionality includes the following. -* [Resize](/examples/resize) -* [Crop](/examples/crop) -* [Rotate](/examples/rotate) -* [Flip](/examples/flip) -* [Blur](/examples/blur) -* [Pixelate](/examples/pixelate) -* [Sharpen](/examples/sharpen) -* [Gray Scale](/examples/gray-scale) -* [Text Overlay](/examples/text-overlay) +* [Resize](resize.md) +* [Crop](crop.md) +* [Rotate](rotate.md) +* [Flip](flip.md) +* [Blur](blur.md) +* [Pixelate](pixelate.md) +* [Sharpen](sharpen.md) +* [Gray Scale](gray-scale.md) +* [Text Overlay](text-overlay.md) -Each operation has examples and you can also refer to [API reference](/api-reference) section for complete list of args. +Each operation has examples and you can also refer to [API reference](../api-reference/index.md) section for complete list of args. -The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](/image-management/query-commands) for more information on our URL query commands. +The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](../getting-started/integration.md) for more information on our URL query commands. !!! success - For more information on how to apply these functionalities using our SDKs please refer to [libraries](/libraries). + For more information on how to apply these functionalities using our SDKs please refer to [libraries](../libraries/index.md). diff --git a/docs/examples/pixelate.md b/docs/examples/pixelate.md index cb58ab1..0247954 100644 --- a/docs/examples/pixelate.md +++ b/docs/examples/pixelate.md @@ -82,4 +82,4 @@ i_c_object_dog,i_o_pixelate_10
[![Pixelate]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_dog,i_o_pixelate_10/000932453002500000000000000000000097.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_dog,i_o_pixelate_10/000932453002500000000000000000000097.jpeg)
!!! note - You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images. + You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images. diff --git a/docs/examples/selection.md b/docs/examples/selection.md index f42e1cb..aa5dcb2 100644 --- a/docs/examples/selection.md +++ b/docs/examples/selection.md @@ -43,4 +43,4 @@ Using A.I. features possibilities are simply endless. Using Inteliver A.I. text detection you can apply image processing functions only on texts. For example pixelating a car plate or applying faster OCR on texts in an image. !!! info - In the [examples](/examples) for each operation we show you how to exploit the full potential of these selection methods. + In the following examples for each operation we show you how to exploit the full potential of these selection methods. diff --git a/docs/examples/sharpen.md b/docs/examples/sharpen.md index d552b07..4968a39 100644 --- a/docs/examples/sharpen.md +++ b/docs/examples/sharpen.md @@ -46,7 +46,7 @@ i_c_object_car,i_o_sharpen
[![Original Image]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_car,i_o_sharpen/000932511633980000000000000000000518.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_object_car,i_o_sharpen/000932511633980000000000000000000518.jpeg)
!!! note - You can lookup the object detection [API reference](/api-reference/object-detection/) to see all the objects we detect in images. + You can lookup the object detection [API reference](../api-reference/object-detection.md) to see all the objects we detect in images. ### Face Sharpen diff --git a/docs/examples/text-overlay.md b/docs/examples/text-overlay.md index 95a6430..2bac0fa 100644 --- a/docs/examples/text-overlay.md +++ b/docs/examples/text-overlay.md @@ -33,4 +33,4 @@ i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_1_14_70_160
[![Textoverlay]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_7_14_70_160/000932246193860000000000000000000437.jpeg)]({{ mediaBase }}/media/v1/{{ cloudName }}/i_c_y_100,i_c_x_-140,i_o_text_inteliver_2.5_7_14_70_160/000932246193860000000000000000000437.jpeg)
!!! note - You can refer to the text overlay [API reference](/api-reference/text-overlay/) to see all the possible values for arguments. + You can refer to the text overlay [API reference](../api-reference/text-overlay.md) to see all the possible values for arguments. diff --git a/docs/getting-started/image-ai.md b/docs/getting-started/image-ai.md index b2967bb..1682f9f 100644 --- a/docs/getting-started/image-ai.md +++ b/docs/getting-started/image-ai.md @@ -62,9 +62,10 @@ Lets say we want to crop the cars in a set of images: !!! note Here we first select car's object by `i_c_object_truck` and then crop it using `i_o_crop` operation. -There are also more examples in [object detection examples](/examples/object-detection). +There are also more examples in [object detection examples](../examples/object-detection.md). -you can also refer to [API reference](/api-reference/object-detection/) section for complete list of args. +!!! info + you can also refer to [API reference](../api-reference/object-detection.md) section for complete list of args. ## Face Detection diff --git a/docs/getting-started/image-compression.md b/docs/getting-started/image-compression.md index fb7d985..ff182c5 100644 --- a/docs/getting-started/image-compression.md +++ b/docs/getting-started/image-compression.md @@ -62,4 +62,4 @@ Here is an image with Real-Time WEBP compression levels of 80, 50 and 20.
Compressed Image Size: 7.1 KB
Compression Ratio: ~37
-you can also refer to [API reference](/api-reference/compression/) section for complete list of args. \ No newline at end of file +you can also refer to [API reference](../api-reference/compression.md) section for complete list of args. \ No newline at end of file diff --git a/docs/getting-started/image-modification.md b/docs/getting-started/image-modification.md index cb6872d..ca5719c 100644 --- a/docs/getting-started/image-modification.md +++ b/docs/getting-started/image-modification.md @@ -7,15 +7,15 @@ title: "Image Modification" Modify your image data using a variety of image processing functions. These functionality includes the following. -- [x] [Resize](/examples/resize) -- [x] [Crop](/examples/crop) -- [x] [Rotate](/examples/rotate) -- [x] [Flip](/examples/flip) -- [x] [Blur](/examples/blur) -- [x] [Pixelate](/examples/pixelate) -- [x] [Sharpen](/examples/sharpen) -- [x] [Gray Scale](/examples/gray-scale) -- [x] [Text Overlay](/examples/text-overlay) +- [x] [Resize](../examples/resize.md) +- [x] [Crop](../examples/crop.md) +- [x] [Rotate](../examples/rotate.md) +- [x] [Flip](../examples/flip.md) +- [x] [Blur](../examples/blur.md) +- [x] [Pixelate](../examples/pixelate.md) +- [x] [Sharpen](../examples/sharpen.md) +- [x] [Gray Scale](../examples/gray-scale.md) +- [x] [Text Overlay](../examples/text-overlay.md) ### Here are simple examples: @@ -86,12 +86,12 @@ the following.
Real-Time Gray Scale
-Each operation has [examples](/examples) and you can also refer to [API reference](/api-reference) section for complete list of args. +Each operation has [examples](../examples/index.md) and you can also refer to [API reference](../api-reference/index.md) section for complete list of args. -The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](/getting-started/how-inteliver-works) for more information on our URL query commands. +The examples uses inteliver intuitive URL query commands. Please refer to [intuitive query commands](how-inteliver-works.md) for more information on our URL query commands. !!! note - For more information on how to apply these functionalities using our SDKs please refer to [libraries](/libraries). + For more information on how to apply these functionalities using our SDKs please refer to [libraries](../libraries/index.md). ## Image Selection @@ -99,7 +99,7 @@ You can apply the operation on different part of image. For selecting the part o an operation you can use the following different selections. -There are examples of each one in [selection section](/examples/selection/) in examples. +There are examples of each one in [selection section](../examples/index.md) in examples. * Window Selection * Face Selection diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 103d92b..69bb74f 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -10,14 +10,14 @@ Welcome to Inteliver, an open-source image management framework designed to stor This guide will help you get up and running with Inteliver, covering the essential concepts and features. ## What We'll Cover -- [x] [Installation and Quick Start](/getting-started/installation): How to install Inteliver and get started. -- [x] [How Inteliver Works](/getting-started/how-inteliver-works): Understanding query commands and the core functionality. -- [x] [Easy Integration](/getting-started/integration): Leveraging intuitive URLs, SDK integration, and DNS integration. -- [x] [Image Modifications Features](/getting-started/image-modification): Exploring the various image modification options. -- [x] [Real-Time Image Compression](/getting-started/image-compression): Understanding the image compression capabilities. -- [x] [A.I. and Image Information](/getting-started/image-ai): Identify objects, Remove background, Detect faces and more. -- [x] [Inteliver Dashboard](/getting-started/inteliver-dashboard): Navigating and utilizing the Inteliver dashboard. -- [x] [Use Cases](/getting-started/usecases): Real-world applications and scenarios for Inteliver. +- [x] [Installation and Quick Start](installation.md): How to install Inteliver and get started. +- [x] [How Inteliver Works](how-inteliver-works.md): Understanding query commands and the core functionality. +- [x] [Easy Integration](integration.md): Leveraging intuitive URLs, SDK integration, and DNS integration. +- [x] [Image Modifications Features](image-modification.md): Exploring the various image modification options. +- [x] [Real-Time Image Compression](image-compression.md): Understanding the image compression capabilities. +- [x] [A.I. and Image Information](image-ai.md): Identify objects, Remove background, Detect faces and more. +- [x] [Inteliver Dashboard](inteliver-dashboard.md): Navigating and utilizing the Inteliver dashboard. +- [x] [Use Cases](usecases.md): Real-world applications and scenarios for Inteliver.
@@ -27,7 +27,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Install and [self-host inteliver](#) or use our [Cloud](#) version - [:octicons-arrow-right-24: Installation](/getting-started/installation) + [:octicons-arrow-right-24: Installation](installation.md) - :fontawesome-solid-wand-magic-sparkles:{ .lg .middle } __How inteliver Works__ @@ -35,7 +35,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Explore inteliver's magic. Understand query commands and sky's the limit - [:octicons-arrow-right-24: Query Commands](/getting-started/how-inteliver-works) + [:octicons-arrow-right-24: Query Commands](how-inteliver-works.md) - :simple-dask:{ .lg .middle } __Easy Integration__ @@ -43,7 +43,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Integrate using simple intuitive URLs, SDK integration, or DNS integration - [:octicons-arrow-right-24: Integration](/getting-started/integration) + [:octicons-arrow-right-24: Integration](integration.md) - :material-image-check:{ .lg .middle } __Image Modifications__ @@ -51,7 +51,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Exploring the various image modification options. - [:octicons-arrow-right-24: Image Modifications](/getting-started/image-modification) + [:octicons-arrow-right-24: Image Modifications](image-modification.md) - :material-quality-high:{ .lg .middle } __Real-Time Image Compression__ @@ -59,7 +59,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Deliver the best quality and size automatically - [:octicons-arrow-right-24: Image Compression](/getting-started/image-compression) + [:octicons-arrow-right-24: Image Compression](image-compression.md) - :material-robot-happy:{ .lg .middle } __A.I. and Image Information__ @@ -68,7 +68,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Identify and tag objects, Remove background, Detect faces and more - [:octicons-arrow-right-24: A.I. Algorithms](/getting-started/image-ai) + [:octicons-arrow-right-24: A.I. Algorithms](image-ai.md) - :material-quality-high:{ .lg .middle } __Inteliver Dashboard__ @@ -76,7 +76,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Using inteliver dashboard you can monitor and analyze all of the platform activity - [:octicons-arrow-right-24: Dashboard](/getting-started/inteliver-dashboard) + [:octicons-arrow-right-24: Dashboard](inteliver-dashboard.md) - :material-quality-high:{ .lg .middle } __Use Cases__ @@ -84,7 +84,7 @@ This guide will help you get up and running with Inteliver, covering the essenti Inteliver is versatile and can be applied in various scenarios - [:octicons-arrow-right-24: Use Cases](/getting-started/usecases) + [:octicons-arrow-right-24: Use Cases](usecases.md)
diff --git a/docs/getting-started/integration.md b/docs/getting-started/integration.md index 1e67a40..883829e 100644 --- a/docs/getting-started/integration.md +++ b/docs/getting-started/integration.md @@ -7,7 +7,7 @@ title: "Integration" ### Intuitive URLs -Without any change in your codes, you can modify your image resources using our intuitive url modifiers. Learn more about [intuitive urls](/image-management/query-commands/). +Without any change in your codes, you can modify your image resources using our intuitive url modifiers. Inteliver delivers the data after processing the query commands and applying the algorithms. @@ -35,9 +35,9 @@ i_w_300,i_o_resize_keep ### SDK Integration Inteliver tries to minimize the integration process by providing SDKs in different programming languages. -Please visit our [libraries](/libraries/) section for integrating using an SDK. +Please visit our [libraries](../libraries/index.md) section for integrating using an SDK. -Inteliver currently provides [Javascript](/libraries/javascript/), [Python](/libraries/python/) and [React](/libraries/react/) SDKs. +Inteliver currently provides [Python](../libraries/python.md), [Javascript](../libraries/javascript.md), and [React](../libraries/react.md) SDKs. !!! note We are updating SDKs to be compatibale with our latest changes. Meanwhile we are more focused on Intuitive URL integration mode. diff --git a/docs/getting-started/inteliver-dashboard.md b/docs/getting-started/inteliver-dashboard.md index c723457..9887b22 100644 --- a/docs/getting-started/inteliver-dashboard.md +++ b/docs/getting-started/inteliver-dashboard.md @@ -8,7 +8,7 @@ Using our management dashboard you can keep track of your requests and sotrage. You can see the library of your images along with analytics and user management. -
![Inteliver Panel Dashboard](/assets/npanel-dashboard.png#roundcorner "Inteliver Panel Dashboard")
+
![Inteliver Panel Dashboard](../assets/npanel-dashboard.png#roundcorner "Inteliver Panel Dashboard")
## Analytics @@ -23,18 +23,18 @@ Using our analytics section you can keep track of the following monthly and dail - [x] Geolocation Information - [x] Media Fromat Information -![Inteliver Panel Analytics](/assets/npanel-analytics-1.png#roundcorner "Inteliver Panel Analytics") +![Inteliver Panel Analytics](../assets/npanel-analytics-1.png#roundcorner "Inteliver Panel Analytics") -![Inteliver Panel Analytics](/assets/npanel-analytics-2.png#roundcorner "Inteliver Panel Analytics") +![Inteliver Panel Analytics](../assets/npanel-analytics-2.png#roundcorner "Inteliver Panel Analytics") ## Storage Using storage section in panel you can upload your image resources and modify images using inteliver intuitive urls modifiers. -![Inteliver Panel Storage](/assets/npanel-storage.png#roundcorner "Inteliver Panel Storage") +![Inteliver Panel Storage](../assets/npanel-storage.png#roundcorner "Inteliver Panel Storage") ## Library Using library section you can view the latest resources added to storage. -![Inteliver Panel Library](/assets/npanel-library.png#roundcorner "Inteliver Panel Library") +![Inteliver Panel Library](../assets/npanel-library.png#roundcorner "Inteliver Panel Library") diff --git a/docs/index.md b/docs/index.md index d11082f..f1f8e73 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,7 +15,7 @@ Inteliver allows for real-time image modifications and customizations, ensuring ## :material-youtube: Watch Introduction Video in Youtube
- [![inteliver Introduction Video](../assets/inteliver-introduction-video-snapshot.svg)](https://www.youtube.com/watch?v=8hEdIEvt7_E) + [![inteliver Introduction Video](assets/inteliver-introduction-video-snapshot.svg)](https://www.youtube.com/watch?v=8hEdIEvt7_E)
inteliver Introduction Video
@@ -31,7 +31,7 @@ Inteliver allows for real-time image modifications and customizations, ensuring Install [`inteliver`](#) with [`pip`](#) and get up and running in minutes - [:octicons-arrow-right-24: Getting started](#) + [:octicons-arrow-right-24: Getting started](getting-started/index.md) - :material-lightbulb-on-10:{ .lg .middle } __It just Works__ @@ -39,7 +39,7 @@ Inteliver allows for real-time image modifications and customizations, ensuring Focus on your core idea and inteliver does all the asset management for you - [:octicons-arrow-right-24: Reference](#) + [:octicons-arrow-right-24: How inteliver works?](getting-started/how-inteliver-works.md) - :material-timer:{ .lg .middle } __Real-Time Image Modification__ @@ -47,7 +47,7 @@ Inteliver allows for real-time image modifications and customizations, ensuring Apply all sorts of image modification on the fly tailored to your client - [:octicons-arrow-right-24: Examples](/examples) + [:octicons-arrow-right-24: Examples](examples/index.md) - :material-scale-balance:{ .lg .middle } __Open Source, MIT__ diff --git a/docs/introduction/features.md b/docs/introduction/features.md index b4fee21..3437709 100644 --- a/docs/introduction/features.md +++ b/docs/introduction/features.md @@ -17,15 +17,15 @@ Modify your image data using a variety of image processing functions. inteliver currently has the following image modifications. - - [x] [Resize](/examples/resize) - - [x] [Crop](/examples/crop) - - [x] [Rotate](/examples/rotate) - - [x] [Flip](/examples/flip) - - [x] [Blur](/examples/blur) - - [x] [Pixelate](/examples/pixelate) - - [x] [Sharpen](/examples/Sharpen) - - [x] [Gray Scale](/examples/gray-scale) - - [x] [Watermark](/examples/text-overlay) + - [x] [Resize](../examples/resize.md) + - [x] [Crop](../examples/crop.md) + - [x] [Rotate](../examples/rotate.md) + - [x] [Flip](../examples/flip.md) + - [x] [Blur](../examples/blur.md) + - [x] [Pixelate](../examples/pixelate.md) + - [x] [Sharpen](../examples/sharpen.md) + - [x] [Gray Scale](../examples/gray-scale.md) + - [x] [Watermark](../examples/text-overlay.md) ## 🔍 Image Information diff --git a/docs/libraries/index.md b/docs/libraries/index.md index 56af3de..c2c294f 100644 --- a/docs/libraries/index.md +++ b/docs/libraries/index.md @@ -16,10 +16,10 @@ Inteliver minimizes the integration process through **Intuitive URL Modifier** c Here are the list of our SDKs: -- [x] [Python](/libraries/python) -- [x] [NodeJS](/libraries/javascript) -- [x] [React](/libraries/react) -- [ ] [Golang](/libraries/golang) +- [x] [Python](../libraries/python.md) +- [x] [NodeJS](../libraries/javascript.md) +- [x] [React](../libraries/react.md) +- [ ] [Golang](../libraries/golang.md) We are continuously working to expand our SDK offerings, ensuring that more languages and frameworks are supported. We encourage you to contribute if you don't see your preferred language or framework listed. \ No newline at end of file diff --git a/docs/libraries/javascript.md b/docs/libraries/javascript.md index c32bc56..6beeac1 100644 --- a/docs/libraries/javascript.md +++ b/docs/libraries/javascript.md @@ -111,4 +111,4 @@ The image you receive after modification is : !!! info - You can find out about the image modification examples at [inteliver Examples](/examples/). \ No newline at end of file + You can find out about the image modification examples at [inteliver Examples](../examples/index.md). \ No newline at end of file diff --git a/docs/libraries/python.md b/docs/libraries/python.md index 5c65206..5218b28 100644 --- a/docs/libraries/python.md +++ b/docs/libraries/python.md @@ -115,4 +115,4 @@ The image you receive after modification is : !!! info - You can find out about the image modification examples at [inteliver Examples](/examples/). \ No newline at end of file + You can find out about the image modification examples at [inteliver Examples](../examples/index.md). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 81a1e38..548b971 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,7 +62,7 @@ nav: - introduction/features.md - introduction/architecture.md - - GettingStarted: + - Getting Started: - getting-started/index.md - getting-started/installation.md - getting-started/how-inteliver-works.md