diff --git a/docs/index.mdx b/docs/index.mdx index e8427e47..f2482a36 100644 --- a/docs/index.mdx +++ b/docs/index.mdx @@ -3,14 +3,8 @@ title: "Introduction" description: "Welcome to the official documentation" --- -**Presenton** is a privacy-first, open-source AI presentation generator that helps you create professional slide decks with ease. Whether you're drafting a pitch, summarizing a research paper, or turning a report into a compelling visual narrative, Presenton streamlines the process using AI, entirely on your local machine. +**Presenton** is an open-source, privacy-first AI presentation generator that runs entirely on your local machine. Designed as a powerful alternative to cloud-based tools like Gamma, Presenton gives users full control over their data and the flexibility to use large language models (LLMs) of their choice. -Unlike cloud-based tools that require data sharing or subscriptions, Presenton gives you full control: +With support for models like **OpenAI**, **Gemini**, and **Ollama**, Presenton allows you to generate high-quality, customizable presentations from simple prompts or document inputs. You can export your slides in PPTX or PDF format and even use GPU-accelerated open-source models for faster, offline generation. -- Run locally using Docker -- Choose your preferred AI model (OpenAI, Gemini, or Ollama) -- Keep your data privateno telemetry, no tracking - -Built with extensibility and transparency in mind, Presenton is ideal for developers, researchers, educators, and privacy-conscious professionals looking for a fast, customizable way to generate slides from text or documents. - -Join the growing open-source community and take back control of your presentation workflow. \ No newline at end of file +Presenton is built with simplicity, flexibility, and transparency in mind โ€” with no tracking, no vendor lock-in, and no hidden costs. Whether you're creating technical decks, business reports, or educational materials, Presenton empowers you to generate presentations securely and efficiently. \ No newline at end of file diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index 9ac2a6ac..b56cc273 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -1,97 +1,31 @@ --- -title: 'Quickstart' -description: 'Start building awesome documentation in under 5 minutes' +title: "Quickstart" +description: "Follow these steps to get Presenton up and running using Docker" --- -## Setup your development +### ๐Ÿš€ Run Presenton -Learn how to update your docs locally and deploy them to the public. +#### ๐Ÿ”ง On Linux or macOS (Bash/Zsh): -### Edit and preview +```bash +docker run -it --name presenton -p 5000:80 -v "./user_data:/app/user_data" ghcr.io/presenton/presenton:v0.3.0-beta +```` - - - During the onboarding process, we created a repository on your Github with - your docs content. You can find this repository on our - [dashboard](https://dashboard.mintlify.com). To clone the repository - locally, follow these - [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) - in your terminal. - - - Previewing helps you make sure your changes look as intended. We built a - command line interface to render these changes locally. - 1. Install the - [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the - documentation changes locally with this command: ``` npm i -g mintlify ``` - 2. Run the following command at the root of your documentation (where - `docs.json` is): ``` mintlify dev ``` - - If youโ€™re currently using the legacy ```mint.json``` configuration file, please update the Mintlify CLI: +#### ๐ŸชŸ On Windows (PowerShell): + +```powershell +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. - ```npm i -g mintlify@latest``` - And run the new upgrade command in your docs repository: +### ๐ŸŒ Open in Your Browser - ```mintlify upgrade``` - You should now be using the new ```docs.json``` configuration file. Feel free to delete the ```mint.json``` file from your repository. - - - +After running the container, open your browser and navigate to: -### Deploy your changes +``` +http://localhost:5000 +``` - - - - Our Github app automatically deploys your changes to your docs site, so you - don't need to manage deployments yourself. You can find the link to install on - your [dashboard](https://dashboard.mintlify.com). Once the bot has been - successfully installed, there should be a check mark next to the commit hash - of the repo. - - - [Commit and push your changes to - Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) - for your changes to update in your docs site. If you push and don't see that - the Github app successfully deployed your changes, you can also manually - update your docs through our [dashboard](https://dashboard.mintlify.com). - - - - -## Update your docs - -Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own. - - - - - Add content to your docs with MDX syntax. - - - - Add code directly to your docs with syntax highlighting. - - - - Add images to your docs to make them more engaging. - - - - Add templates to your docs to make them more reusable. - - - +Youโ€™re now ready to start generating presentations!