diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..a0e77169 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,32 @@ +# Mintlify Starter Kit + +Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including + +- Guide pages +- Navigation +- Customizations +- API Reference pages +- Use of popular components + +### Development + +Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command + +``` +npm i -g mintlify +``` + +Run the following command at the root of your documentation (where docs.json is) + +``` +mintlify dev +``` + +### Publishing Changes + +Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. + +#### Troubleshooting + +- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. +- Page loads as a 404 - Make sure you are running in a folder with `docs.json` diff --git a/docs/api-reference/endpoint/create.mdx b/docs/api-reference/endpoint/create.mdx new file mode 100644 index 00000000..5689f1b6 --- /dev/null +++ b/docs/api-reference/endpoint/create.mdx @@ -0,0 +1,4 @@ +--- +title: 'Create Plant' +openapi: 'POST /plants' +--- diff --git a/docs/api-reference/endpoint/delete.mdx b/docs/api-reference/endpoint/delete.mdx new file mode 100644 index 00000000..657dfc87 --- /dev/null +++ b/docs/api-reference/endpoint/delete.mdx @@ -0,0 +1,4 @@ +--- +title: 'Delete Plant' +openapi: 'DELETE /plants/{id}' +--- diff --git a/docs/api-reference/endpoint/get.mdx b/docs/api-reference/endpoint/get.mdx new file mode 100644 index 00000000..56aa09ec --- /dev/null +++ b/docs/api-reference/endpoint/get.mdx @@ -0,0 +1,4 @@ +--- +title: 'Get Plants' +openapi: 'GET /plants' +--- diff --git a/docs/api-reference/endpoint/webhook.mdx b/docs/api-reference/endpoint/webhook.mdx new file mode 100644 index 00000000..32913402 --- /dev/null +++ b/docs/api-reference/endpoint/webhook.mdx @@ -0,0 +1,4 @@ +--- +title: 'New Plant' +openapi: 'WEBHOOK /plant/webhook' +--- diff --git a/docs/api-reference/introduction.mdx b/docs/api-reference/introduction.mdx new file mode 100644 index 00000000..c835b78b --- /dev/null +++ b/docs/api-reference/introduction.mdx @@ -0,0 +1,33 @@ +--- +title: 'Introduction' +description: 'Example section for showcasing API endpoints' +--- + + + If you're not looking to build API reference documentation, you can delete + this section by removing the api-reference folder. + + +## Welcome + +There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. + + + View the OpenAPI specification file + + +## Authentication + +All API endpoints are authenticated using Bearer tokens and picked up from the specification file. + +```json +"security": [ + { + "bearerAuth": [] + } +] +``` diff --git a/docs/api-reference/openapi.json b/docs/api-reference/openapi.json new file mode 100644 index 00000000..da5326ef --- /dev/null +++ b/docs/api-reference/openapi.json @@ -0,0 +1,217 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "OpenAPI Plant Store", + "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", + "license": { + "name": "MIT" + }, + "version": "1.0.0" + }, + "servers": [ + { + "url": "http://sandbox.mintlify.com" + } + ], + "security": [ + { + "bearerAuth": [] + } + ], + "paths": { + "/plants": { + "get": { + "description": "Returns all plants from the system that the user has access to", + "parameters": [ + { + "name": "limit", + "in": "query", + "description": "The maximum number of results to return", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "Plant response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/Plant" + } + } + } + } + }, + "400": { + "description": "Unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + }, + "post": { + "description": "Creates a new plant in the store", + "requestBody": { + "description": "Plant to add to the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewPlant" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "plant response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Plant" + } + } + } + }, + "400": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + }, + "/plants/{id}": { + "delete": { + "description": "Deletes a single plant based on the ID supplied", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "ID of plant to delete", + "required": true, + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "204": { + "description": "Plant deleted", + "content": {} + }, + "400": { + "description": "unexpected error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Error" + } + } + } + } + } + } + } + }, + "webhooks": { + "/plant/webhook": { + "post": { + "description": "Information about a new plant added to the store", + "requestBody": { + "description": "Plant added to the store", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/NewPlant" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + } + } + } + }, + "components": { + "schemas": { + "Plant": { + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the plant", + "type": "string" + }, + "tag": { + "description": "Tag to specify the type", + "type": "string" + } + } + }, + "NewPlant": { + "allOf": [ + { + "$ref": "#/components/schemas/Plant" + }, + { + "required": [ + "id" + ], + "type": "object", + "properties": { + "id": { + "description": "Identification number of the plant", + "type": "integer", + "format": "int64" + } + } + } + ] + }, + "Error": { + "required": [ + "error", + "message" + ], + "type": "object", + "properties": { + "error": { + "type": "integer", + "format": "int32" + }, + "message": { + "type": "string" + } + } + } + }, + "securitySchemes": { + "bearerAuth": { + "type": "http", + "scheme": "bearer" + } + } + } +} \ No newline at end of file diff --git a/docs/configurations/environment-variables.mdx b/docs/configurations/environment-variables.mdx new file mode 100644 index 00000000..db3f99bf --- /dev/null +++ b/docs/configurations/environment-variables.mdx @@ -0,0 +1,43 @@ +--- +title: "Environment Variables" +description: "Configure Presenton using environment variables." +--- + +Presenton can be customized and secured using environment variables. Below are the key variables you can set when running the app: + +- **`CAN_CHANGE_KEYS`**\ + Controls whether users can modify API keys through the app interface.\ + Set to `"false"` to keep keys hidden and unchangeable, or `"true"` to allow changes.\ + _Example:_ `CAN_CHANGE_KEYS="false"` + +- **`LLM`**\ + Select which Large Language Model provider Presenton should use.\ + Supported values: `"openai"`, `"google"`, `"ollama"`.\ + _Example:_ `LLM="openai"` + +- **`OPENAI_API_KEY`**\ + Your OpenAI API key. Required if `LLM` is set to `"openai"`.\ + _Example:_ `OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxx"` + +- **`GOOGLE_API_KEY`**\ + Your Google API key. Required if `LLM` is set to `"google"`.\ + _Example:_ `GOOGLE_API_KEY="AIzaSyXXXXXXXXXXXX"` + +- **`OLLAMA_MODEL`**\ + The Ollama model name to use. Required if `LLM` is set to `"ollama"`.\ + _Example:_ `OLLAMA_MODEL="llama3.2:3b"` + +- **`PEXELS_API_KEY`**\ + API key for the Pexels image service. Optional but recommended when using Ollama models to enhance image search.\ + _Example:_ `PEXELS_API_KEY="vzXXXXXXXXXXXXXX"` + +### Example: Running Presenton with Environment Variables + +```bash +docker run -it --name presenton -p 5000:80 \ + -e LLM="openai" \ + -e OPENAI_API_KEY="your_openai_api_key" \ + -e CAN_CHANGE_KEYS="false" \ + -v "./user_data:/app/user_data" \ + ghcr.io/presenton/presenton:v0.3.0-beta +``` \ No newline at end of file diff --git a/docs/configurations/using-gpu.mdx b/docs/configurations/using-gpu.mdx new file mode 100644 index 00000000..6c3c106a --- /dev/null +++ b/docs/configurations/using-gpu.mdx @@ -0,0 +1,37 @@ +--- +title: "Using GPU" +description: "Runing Ollama models on GPU" +--- + +Presenton supports GPU acceleration when using Ollama models, significantly improving performance β€” especially for larger models. + +To enable GPU support, you need to install and configure the **NVIDIA Container Toolkit**. + +### πŸ› οΈ Step 1: Install NVIDIA Container Toolkit + +Follow the official guide to install the toolkit:\ +πŸ‘‰ https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html + +### πŸš€ Step 2: Run Presenton with GPU + +Once installed, use the `--gpus=all` flag when running the container: + +- **Running without environment variables** + +```bash +docker run -it --name presenton --gpus=all -p 5000:80 \ + -v "./user_data:/app/user_data" \ + ghcr.io/presenton/presenton:v0.3.0-beta +``` + +- **Running with environment variables** + +```bash +docker run -it --name presenton --gpus=all -p 5000:80 \ + -e LLM="ollama" \ + -e OLLAMA_MODEL="llama3.2:3b" \ + -e PEXELS_API_KEY="your_pexels_api_key" \ + -e CAN_CHANGE_KEYS="false" \ + -v "./user_data:/app/user_data" \ + ghcr.io/presenton/presenton:v0.3.0-beta +``` \ No newline at end of file diff --git a/docs/configurations/using-ollama-models.mdx b/docs/configurations/using-ollama-models.mdx new file mode 100644 index 00000000..a762f7eb --- /dev/null +++ b/docs/configurations/using-ollama-models.mdx @@ -0,0 +1,73 @@ +--- +title: "Using Ollama Models" +description: "Follow these steps to generate presentations using Ollama" +--- + +Presenton supports running fully offline using open-source models via [Ollama](https://ollama.com/). This allows you to generate presentations without relying on cloud APIs β€” keeping your data private and costs low. + +### πŸš€ Run Presenton with an Ollama Model + +Make sure you have [Ollama installed](https://ollama.com/download) and models downloaded if running them outside Docker. + +To run Presenton with an Ollama model: + +```bash +docker run -it --name presenton -p 5000:80 \ + -e LLM="ollama" \ + -e OLLAMA_MODEL="llama3.2:3b" \ + -e PEXELS_API_KEY="your_pexels_api_key" \ + -e CAN_CHANGE_KEYS="false" \ + -v "./user_data:/app/user_data" \ + ghcr.io/presenton/presenton:v0.3.0-beta +``` + +> πŸ’‘ **Note:** A valid **Pexels API key is required** for image generation when using Ollama models. +> You can get a free API key at https://www.pexels.com/api/ + +> βœ… Add `--gpus=all` to enable GPU acceleration (see [Using GPU](/docs/configurations/using-gpu)). + +### 🧠 Supported Ollama Models + +| Model | Size | Graph Support | +| ------------------- | ------ | ------------- | +| **Llama Models** | | | +| `llama3:8b` | 4.7 GB | ❌ No | +| `llama3:70b` | 40 GB | βœ… Yes | +| `llama3.1:8b` | 4.9 GB | ❌ No | +| `llama3.1:70b` | 43 GB | βœ… Yes | +| `llama3.1:405b` | 243 GB | βœ… Yes | +| `llama3.2:1b` | 1.3 GB | ❌ No | +| `llama3.2:3b` | 2 GB | ❌ No | +| `llama3.3:70b` | 43 GB | βœ… Yes | +| `llama4:16x17b` | 67 GB | βœ… Yes | +| `llama4:128x17b` | 245 GB | βœ… Yes | +| **Gemma Models** | | | +| `gemma3:1b` | 815 MB | ❌ No | +| `gemma3:4b` | 3.3 GB | ❌ No | +| `gemma3:12b` | 8.1 GB | ❌ No | +| `gemma3:27b` | 17 GB | βœ… Yes | +| **DeepSeek Models** | | | +| `deepseek-r1:1.5b` | 1.1 GB | ❌ No | +| `deepseek-r1:7b` | 4.7 GB | ❌ No | +| `deepseek-r1:8b` | 5.2 GB | ❌ No | +| `deepseek-r1:14b` | 9 GB | ❌ No | +| `deepseek-r1:32b` | 20 GB | βœ… Yes | +| `deepseek-r1:70b` | 43 GB | βœ… Yes | +| `deepseek-r1:671b` | 404 GB | βœ… Yes | +| **Qwen Models** | | | +| `qwen3:0.6b` | 523 MB | ❌ No | +| `qwen3:1.7b` | 1.4 GB | ❌ No | +| `qwen3:4b` | 2.6 GB | ❌ No | +| `qwen3:8b` | 5.2 GB | ❌ No | +| `qwen3:14b` | 9.3 GB | ❌ No | +| `qwen3:30b` | 19 GB | βœ… Yes | +| `qwen3:32b` | 20 GB | βœ… Yes | +| `qwen3:235b` | 142 GB | βœ… Yes | + +> βœ… **Graph Support** means the model can generate charts and diagrams in presentations. + +### πŸ“Œ Additional Notes + +- Use the `OLLAMA_MODEL` environment variable to select any supported model. +- Ensure your system has enough RAM or GPU memory to handle the model. +- Always include a `PEXELS_API_KEY` for full image generation functionality. \ No newline at end of file diff --git a/docs/development.mdx b/docs/development.mdx new file mode 100644 index 00000000..65fd3dce --- /dev/null +++ b/docs/development.mdx @@ -0,0 +1,35 @@ +--- +title: 'Development' +description: 'Run and test Presenton locally to develop features, make changes, and preview updates in a safe development environment' +--- + + + **Prerequisite**: Please install Docker on your machine before proceeding.
+ You can get Docker from [https://www.docker.com/get-started](https://www.docker.com/get-started). + + +### Clone the Repository + +```bash +git clone https://github.com/presenton/presenton.git +cd presenton +```` + +### Run with Docker Compose + +Build and start the development environment using Docker Compose: + +```bash +docker compose up development --build +``` + +This command will build the development container and start the app. Once running, you can access Presenton at: + +``` +http://localhost:5000 +``` + +### Notes + +* The `development` service includes live reload and debugging support for easier development. +* To stop the environment, press `Ctrl + C` and then run `docker compose down` to clean up. \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json new file mode 100644 index 00000000..526b2b70 --- /dev/null +++ b/docs/docs.json @@ -0,0 +1,72 @@ +{ + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Presenton Documentation", + "colors": { + "primary": "#4a2ea6", + "light": "#5b39cb", + "dark": "#3a2481" + }, + "favicon": "/favicon.svg", + "navigation": { + "tabs": [ + { + "tab": "Guides", + "groups": [ + { + "group": "Get Started", + "pages": [ + "index", + "quickstart", + "development" + ] + }, + { + "group": "Configurations", + "pages": [ + "configurations/environment-variables", + "configurations/using-ollama-models", + "configurations/using-gpu" + ] + } + ] + } + ], + "global": { + "anchors": [ + { + "anchor": "Community", + "href": "https://discord.gg/xmJkX8G6", + "icon": "discord" + }, + { + "anchor": "Blog", + "href": "https://presenton.ai/blogs", + "icon": "newspaper" + } + ] + } + }, + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg" + }, + "navbar": { + "links": [ + { + "label": "Support", + "href": "mailto:suraj@presenton.ai" + } + ], + "primary": { + "type": "button", + "label": "Dashboard", + "href": "https://presenton.ai/dashboard" + } + }, + "footer": { + "socials": { + "github": "https://github.com/presenton/presenton" + } + } +} \ No newline at end of file diff --git a/docs/essentials/code.mdx b/docs/essentials/code.mdx new file mode 100644 index 00000000..d2a462a7 --- /dev/null +++ b/docs/essentials/code.mdx @@ -0,0 +1,37 @@ +--- +title: 'Code Blocks' +description: 'Display inline code and code blocks' +icon: 'code' +--- + +## Basic + +### Inline Code + +To denote a `word` or `phrase` as code, enclose it in backticks (`). + +``` +To denote a `word` or `phrase` as code, enclose it in backticks (`). +``` + +### Code Block + +Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language. + +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` + +````md +```java HelloWorld.java +class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello, World!"); + } +} +``` +```` diff --git a/docs/essentials/images.mdx b/docs/essentials/images.mdx new file mode 100644 index 00000000..60ad42d3 --- /dev/null +++ b/docs/essentials/images.mdx @@ -0,0 +1,59 @@ +--- +title: 'Images and Embeds' +description: 'Add image, video, and other HTML elements' +icon: 'image' +--- + + + +## Image + +### Using Markdown + +The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code + +```md +![title](/path/image.jpg) +``` + +Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed. + +### Using Embeds + +To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images + +```html + +``` + +## Embeds and HTML elements + + + +
+ + + +Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility. + + + +### iFrames + +Loads another HTML page within the document. Most commonly used for embedding videos. + +```html + +``` diff --git a/docs/essentials/markdown.mdx b/docs/essentials/markdown.mdx new file mode 100644 index 00000000..c8ad9c1f --- /dev/null +++ b/docs/essentials/markdown.mdx @@ -0,0 +1,88 @@ +--- +title: 'Markdown Syntax' +description: 'Text, title, and styling in standard markdown' +icon: 'text-size' +--- + +## Titles + +Best used for section headers. + +```md +## Titles +``` + +### Subtitles + +Best use to subsection headers. + +```md +### Subtitles +``` + + + +Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right. + + + +## Text Formatting + +We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it. + +| Style | How to write it | Result | +| ------------- | ----------------- | --------------- | +| Bold | `**bold**` | **bold** | +| Italic | `_italic_` | _italic_ | +| Strikethrough | `~strikethrough~` | ~strikethrough~ | + +You can combine these. For example, write `**_bold and italic_**` to get **_bold and italic_** text. + +You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text. + +| Text Size | How to write it | Result | +| ----------- | ------------------------ | ---------------------- | +| Superscript | `superscript` | superscript | +| Subscript | `subscript` | subscript | + +## Linking to Pages + +You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com). + +Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section. + +Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily. + +## Blockquotes + +### Singleline + +To create a blockquote, add a `>` in front of a paragraph. + +> Dorothy followed her through many of the beautiful rooms in her castle. + +```md +> Dorothy followed her through many of the beautiful rooms in her castle. +``` + +### Multiline + +> Dorothy followed her through many of the beautiful rooms in her castle. +> +> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. + +```md +> Dorothy followed her through many of the beautiful rooms in her castle. +> +> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood. +``` + +### LaTeX + +Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component. + +8 x (vk x H1 - H2) = (0,1) + +```md +8 x (vk x H1 - H2) = (0,1) +``` diff --git a/docs/essentials/navigation.mdx b/docs/essentials/navigation.mdx new file mode 100644 index 00000000..f21213c0 --- /dev/null +++ b/docs/essentials/navigation.mdx @@ -0,0 +1,87 @@ +--- +title: 'Navigation' +description: 'The navigation field in docs.json defines the pages that go in the navigation menu' +icon: 'map' +--- + +The navigation menu is the list of links on every website. + +You will likely update `docs.json` every time you add a new page. Pages do not show up automatically. + +## Navigation syntax + +Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names. + + + +```json Regular Navigation +"navigation": { + "tabs": [ + { + "tab": "Docs", + "groups": [ + { + "group": "Getting Started", + "pages": ["quickstart"] + } + ] + } + ] +} +``` + +```json Nested Navigation +"navigation": { + "tabs": [ + { + "tab": "Docs", + "groups": [ + { + "group": "Getting Started", + "pages": [ + "quickstart", + { + "group": "Nested Reference Pages", + "pages": ["nested-reference-page"] + } + ] + } + ] + } + ] +} +``` + + + +## Folders + +Simply put your MDX files in folders and update the paths in `docs.json`. + +For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`. + + + +You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted. + + + +```json Navigation With Folder +"navigation": { + "tabs": [ + { + "tab": "Docs", + "groups": [ + { + "group": "Group Name", + "pages": ["your-folder/your-page"] + } + ] + } + ] +} +``` + +## Hidden Pages + +MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them. diff --git a/docs/essentials/reusable-snippets.mdx b/docs/essentials/reusable-snippets.mdx new file mode 100644 index 00000000..a0a55297 --- /dev/null +++ b/docs/essentials/reusable-snippets.mdx @@ -0,0 +1,110 @@ +--- +title: Reusable Snippets +description: Reusable, custom snippets to keep content in sync +icon: 'recycle' +--- + +import SnippetIntro from '/snippets/snippet-intro.mdx'; + + + +## Creating a custom snippet + +**Pre-condition**: You must create your snippet file in the `snippets` directory. + + + Any page in the `snippets` directory will be treated as a snippet and will not + be rendered into a standalone page. If you want to create a standalone page + from the snippet, import the snippet into another file and call it as a + component. + + +### Default export + +1. Add content to your snippet file that you want to re-use across multiple + locations. Optionally, you can add variables that can be filled in via props + when you import the snippet. + +```mdx snippets/my-snippet.mdx +Hello world! This is my content I want to reuse across pages. My keyword of the +day is {word}. +``` + + + The content that you want to reuse must be inside the `snippets` directory in + order for the import to work. + + +2. Import the snippet into your destination file. + +```mdx destination-file.mdx +--- +title: My title +description: My Description +--- + +import MySnippet from '/snippets/path/to/my-snippet.mdx'; + +## Header + +Lorem impsum dolor sit amet. + + +``` + +### Reusable variables + +1. Export a variable from your snippet file: + +```mdx snippets/path/to/custom-variables.mdx +export const myName = 'my name'; + +export const myObject = { fruit: 'strawberries' }; +``` + +2. Import the snippet from your destination file and use the variable: + +```mdx destination-file.mdx +--- +title: My title +description: My Description +--- + +import { myName, myObject } from '/snippets/path/to/custom-variables.mdx'; + +Hello, my name is {myName} and I like {myObject.fruit}. +``` + +### Reusable components + +1. Inside your snippet file, create a component that takes in props by exporting + your component in the form of an arrow function. + +```mdx snippets/custom-component.mdx +export const MyComponent = ({ title }) => ( +
+

{title}

+

... snippet content ...

+
+); +``` + + + MDX does not compile inside the body of an arrow function. Stick to HTML + syntax when you can or use a default export if you need to use MDX. + + +2. Import the snippet into your destination file and pass in the props + +```mdx destination-file.mdx +--- +title: My title +description: My Description +--- + +import { MyComponent } from '/snippets/custom-component.mdx'; + +Lorem ipsum dolor sit amet. + + +``` diff --git a/docs/essentials/settings.mdx b/docs/essentials/settings.mdx new file mode 100644 index 00000000..884de13a --- /dev/null +++ b/docs/essentials/settings.mdx @@ -0,0 +1,318 @@ +--- +title: 'Global Settings' +description: 'Mintlify gives you complete control over the look and feel of your documentation using the docs.json file' +icon: 'gear' +--- + +Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below. + +## Properties + + +Name of your project. Used for the global title. + +Example: `mintlify` + + + + + An array of groups with all the pages within that group + + + The name of the group. + + Example: `Settings` + + + + The relative paths to the markdown files that will serve as pages. + + Example: `["customization", "page"]` + + + + + + + + Path to logo image or object with path to "light" and "dark" mode logo images + + + Path to the logo in light mode + + + Path to the logo in dark mode + + + Where clicking on the logo links you to + + + + + + Path to the favicon image + + + + Hex color codes for your global theme + + + The primary color. Used for most often for highlighted content, section + headers, accents, in light mode + + + The primary color for dark mode. Used for most often for highlighted + content, section headers, accents, in dark mode + + + The primary color for important buttons + + + The color of the background in both light and dark mode + + + The hex color code of the background in light mode + + + The hex color code of the background in dark mode + + + + + + + + Array of `name`s and `url`s of links you want to include in the topbar + + + The name of the button. + + Example: `Contact us` + + + The url once you click on the button. Example: `https://mintlify.com/docs` + + + + + + + + + Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars. + + + If `link`: What the button links to. + + If `github`: Link to the repository to load GitHub information from. + + + Text inside the button. Only required if `type` is a `link`. + + + + + + + Array of version names. Only use this if you want to show different versions + of docs with a dropdown in the navigation bar. + + + + An array of the anchors, includes the `icon`, `color`, and `url`. + + + The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor. + + Example: `comments` + + + The name of the anchor label. + + Example: `Community` + + + The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in. + + + The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color. + + + Used if you want to hide an anchor until the correct docs version is selected. + + + Pass `true` if you want to hide the anchor until you directly link someone to docs inside it. + + + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" + + + + + + + Override the default configurations for the top-most anchor. + + + The name of the top-most anchor + + + Font Awesome icon. + + + One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin" + + + + + + An array of navigational tabs. + + + The name of the tab label. + + + The start of the URL that marks what pages go in the tab. Generally, this + is the name of the folder you put your pages in. + + + + + + Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo). + + + The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url + options that the user can toggle. + + + + + + The authentication strategy used for all API endpoints. + + + The name of the authentication parameter used in the API playground. + + If method is `basic`, the format should be `[usernameName]:[passwordName]` + + + The default value that's designed to be a prefix for the authentication input field. + + E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`. + + + + + + Configurations for the API playground + + + + Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple` + + Learn more at the [playground guides](/api-playground/demo) + + + + + + Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file. + + This behavior will soon be enabled by default, at which point this field will be deprecated. + + + + + + + A string or an array of strings of URL(s) or relative path(s) pointing to your + OpenAPI file. + + Examples: + + ```json Absolute + "openapi": "https://example.com/openapi.json" + ``` + ```json Relative + "openapi": "/openapi.json" + ``` + ```json Multiple + "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"] + ``` + + + + + + An object of social media accounts where the key:property pair represents the social media platform and the account url. + + Example: + ```json + { + "x": "https://x.com/mintlify", + "website": "https://mintlify.com" + } + ``` + + + One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news` + + Example: `x` + + + The URL to the social platform. + + Example: `https://x.com/mintlify` + + + + + + Configurations to enable feedback buttons + + + + Enables a button to allow users to suggest edits via pull requests + + + Enables a button to allow users to raise an issue about the documentation + + + + + + Customize the dark mode toggle. + + + Set if you always want to show light or dark mode for new users. When not + set, we default to the same mode as the user's operating system. + + + Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example: + + + ```json Only Dark Mode + "modeToggle": { + "default": "dark", + "isHidden": true + } + ``` + + ```json Only Light Mode + "modeToggle": { + "default": "light", + "isHidden": true + } + ``` + + + + + + + + + A background image to be displayed behind every page. See example with + [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io). + diff --git a/docs/favicon.svg b/docs/favicon.svg new file mode 100644 index 00000000..59cc3575 --- /dev/null +++ b/docs/favicon.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/docs/index.mdx b/docs/index.mdx new file mode 100644 index 00000000..e69a746a --- /dev/null +++ b/docs/index.mdx @@ -0,0 +1,20 @@ +--- +title: "Introduction" +description: "Welcome to Presenton β€” your AI presentation generator" +--- + +**Presenton** is an open-source AI presentation generator that runs entirely on your local machine. Built as a powerful alternative to cloud-based tools like Gamma, Presenton offers you complete ownership of your data and full control over how presentations are generated. + +With seamless support for multiple large language models (LLMs)β€”including **OpenAI**, **Google Gemini**, and **Ollama**β€”you can generate high-quality, customizable slide decks from simple prompts or uploaded documents. Export your output in **PPTX** or **PDF** format and, when using Ollama, enjoy GPU-accelerated, fully offline generation with open-source models. + +Presenton is designed around three core principles: + +- **Simplicity** – No complex setup or vendor-specific tooling. + +- **Flexibility** – Choose your preferred LLM, define your own themes, and fine-tune the generation workflow. + +- **Transparency** – No telemetry, no vendor lock-in, and no hidden costs. + +Whether you're building technical presentations, summarizing reports, or creating educational materials, Presenton empowers you to work **securely**, **efficiently**, and **on your own terms**β€”with complete freedom over your infrastructure, APIs, and data. + +Join the open-source movement and redefine how presentations are madeβ€”\*\*your slides, your way.\*\* \ No newline at end of file diff --git a/docs/logo/dark.svg b/docs/logo/dark.svg new file mode 100644 index 00000000..80da82f9 --- /dev/null +++ b/docs/logo/dark.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/logo/light.svg b/docs/logo/light.svg new file mode 100644 index 00000000..80da82f9 --- /dev/null +++ b/docs/logo/light.svg @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx new file mode 100644 index 00000000..ae85dcf4 --- /dev/null +++ b/docs/quickstart.mdx @@ -0,0 +1,31 @@ +--- +title: "Quickstart" +description: "Follow these steps to get Presenton up and running using Docker" +--- + +### πŸš€ Run Presenton + +#### πŸ”§ On Linux or macOS (Bash/Zsh): + +```bash +docker run -it --name presenton -p 5000:80 -v "./user_data:/app/user_data" ghcr.io/presenton/presenton:v0.3.0-beta +```` + +#### πŸͺŸ On Windows (PowerShell): + +```bash +docker run -it --name presenton -p 5000:80 -v "${PWD}\user_data:/app/user_data" ghcr.io/presenton/presenton:v0.3.0-beta +``` + +> βœ… You can replace `5000` with any other available port to avoid conflicts. + + +### 🌐 Open in Your Browser + +After running the container, open your browser and navigate to: + +``` +http://localhost:5000 +``` + +You’re now ready to start generating presentations! diff --git a/docs/snippets/snippet-intro.mdx b/docs/snippets/snippet-intro.mdx new file mode 100644 index 00000000..c57e7c75 --- /dev/null +++ b/docs/snippets/snippet-intro.mdx @@ -0,0 +1,4 @@ +One of the core principles of software development is DRY (Don't Repeat +Yourself). This is a principle that apply to documentation as +well. If you find yourself repeating the same content in multiple places, you +should consider creating a custom snippet to keep your content in sync.