# Contextual menu Source: https://wiki.diversity.cz/agent-ready/contextual Give readers one-click access to AI tools and integrations The contextual toolbar is a floating action bar that appears on every page of your docs. It lets readers instantly copy page content, open it in an AI assistant, or add your docs as an MCP server — without leaving the page. Configure it in `docs.json` under `contextual.options`: ```json docs.json theme={null} { "contextual": { "options": ["copy", "view", "claude", "chatgpt", "mcp", "cursor", "vscode"] } } ``` ## Available options ### Content actions | Option | Description | | ------ | ------------------------------------------------------ | | `copy` | Copies the page as Markdown to the clipboard | | `view` | Opens the raw Markdown version of the page (`.md` URL) | ### AI assistants | Option | Description | | ------------ | ---------------------------------- | | `claude` | Opens the page in Claude | | `chatgpt` | Opens the page in ChatGPT | | `perplexity` | Opens the page in Perplexity | | `grok` | Opens the page in Grok | | `aistudio` | Opens the page in Google AI Studio | ### Editor integrations | Option | Description | | ---------- | ----------------------------------- | | `cursor` | Adds the page to Cursor's context | | `vscode` | Adds the page to VS Code Copilot | | `windsurf` | Adds the page to Windsurf's Cascade | | `devin` | Opens the page in Devin | ### MCP | Option | Description | | --------- | --------------------------------------------------------------------- | | `mcp` | Shows instructions for using your docs as an MCP server | | `add-mcp` | Provides a one-click prompt to add your docs MCP server to an AI tool | The `mcp` and `add-mcp` options are especially powerful — they let developers connect your entire docs site to any MCP-compatible AI assistant, so it can answer questions about your product directly. ## Custom options You can add custom entries to the toolbar with a title, description, icon, and link. The `href` supports dynamic placeholders: | Placeholder | Resolves to | | ----------- | --------------------------- | | `$page` | The current page's full URL | | `$path` | The current page's path | | `$mcp` | Your docs MCP server URL | ```json docs.json theme={null} { "contextual": { "options": [ "copy", "claude", { "title": "Open issue", "description": "Report a problem with this page", "icon": "github", "href": "https://github.com/your-org/docs/issues/new?title=Issue+on+$path" } ] } } ``` The contextual toolbar is only visible on preview and production deployments, not in `mint dev` local preview. ## Pairing with Visibility The toolbar's `copy` and `view` options expose your page's Markdown content directly. If you use the [`Visibility`](/agent-ready/visibility) component, the `for="agents"` blocks will be included in that Markdown — giving AI assistants structured context that human readers don't see. # Prompt component Source: https://wiki.diversity.cz/agent-ready/prompt Embed shareable AI prompts readers can copy or open in Cursor The `Prompt` component displays a pre-built AI prompt with one-click actions to copy it to the clipboard or open it directly in Cursor. It's ideal for any docs page where you want to hand readers a ready-to-use prompt. ## Basic usage You are a technical writer. Given the following API endpoint documentation, write a one-paragraph summary that explains what the endpoint does, what inputs it requires, and what it returns. Be concise and use plain language. ```mdx theme={null} You are a technical writer. Given the following API endpoint documentation, write a one-paragraph summary that explains what the endpoint does, what inputs it requires, and what it returns. Be concise and use plain language. ``` ## With Cursor integration Add `actions={["copy", "cursor"]}` to also surface an "Open in Cursor" button. This is especially useful for prompts readers will use in their editor. You are an expert TypeScript developer. Given the following OpenAPI specification, generate a fully-typed API client using native fetch. Include: * A base client class with configurable baseUrl and auth headers * One method per endpoint, with typed request parameters and response types * JSDoc comments on each method Do not use any third-party HTTP libraries. ```mdx theme={null} You are an expert TypeScript developer. Given the following OpenAPI specification, generate a fully-typed API client using native fetch... ``` ## Props Heading text shown above the prompt content. Supports Markdown. The prompt text that gets copied or sent to Cursor. Which action buttons to show. Options: `"copy"`, `"cursor"`. Defaults to `["copy"]`. An icon displayed alongside the description. Supports Font Awesome, Lucide, and Tabler icon names, image URLs, or inline SVG. ## When to use it The `Prompt` component works well anywhere you're teaching readers to work with AI: * **Quickstart guides** — give readers a prompt to generate their first integration * **API reference pages** — include a prompt for generating client code from the spec * **Troubleshooting guides** — embed a debugging prompt readers can run against their own error logs * **Conceptual pages** — add a prompt for exploring the topic further with an AI assistant # Visibility Source: https://wiki.diversity.cz/agent-ready/visibility Show different content to humans and AI agents The `Visibility` component lets a single page serve two audiences: humans reading on the web and AI agents processing the Markdown output. Content marked `for="humans"` appears on the rendered page but is excluded from Markdown exports. Content marked `for="agents"` is hidden on the web but included in Markdown. This means you can write conversational, UI-centric instructions for humans and structured, machine-readable instructions for AI — without maintaining two separate pages. ## How it works Mintlify serves every page at two URLs: * `https://docs.example.com/page` — the rendered site, for humans * `https://docs.example.com/page.md` — the raw Markdown, for AI agents `Visibility` controls what appears at each URL. ## Example ```mdx theme={null} Navigate to [dashboard.example.com](https://dashboard.example.com) and sign in. Go to **Settings → API Keys** and click **New key**. To authenticate, send a POST request to `/v1/auth/token` with the user's email and password in the request body. The response includes a bearer token valid for 24 hours. Pass this token as `Authorization: Bearer ` on all subsequent requests. ``` Human readers see the step-by-step UI walkthrough. AI agents processing the Markdown get the direct API instructions instead. ## Props * `"humans"` — visible on the rendered web page, excluded from `.md` export * `"agents"` — hidden on the rendered web page, included in `.md` export ## When to use it Show UI screenshots and button clicks to humans. Give agents the equivalent API calls. Show a visual settings panel to humans. Give agents the equivalent JSON or CLI flags. Show a friendly explanation to humans. Give agents structured error codes and remediation steps. Include rich diagrams and narrative for humans. Provide a concise structured summary for agents. ## Combining with Prompt `Visibility` and `Prompt` complement each other well. Use `Visibility` to give agents structured context, then use `Prompt` to give human readers a prompt they can use to ask an AI about that same content. ```mdx theme={null} ## Authentication schema - Method: Bearer token - Header: `Authorization: Bearer ` - Token TTL: 86400 seconds - Refresh endpoint: POST /v1/auth/refresh Explain how authentication works in this API and show me example code for getting a token and making an authenticated request. ``` # Claude Code setup Source: https://wiki.diversity.cz/ai-tools/claude-code Configure Claude Code for your documentation workflow Set up Claude Code to help you write and maintain your Mintlify documentation. ## Prerequisites * Active Claude subscription (Pro, Max, or API access) ## Setup ```bash theme={null} npm install -g @anthropic-ai/claude-code ``` In your docs directory, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Claude Code Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. ```bash theme={null} claude ``` # Cursor setup Source: https://wiki.diversity.cz/ai-tools/cursor Configure Cursor for your documentation workflow Set up Cursor to help you write and maintain your Mintlify documentation. ## Prerequisites * Cursor editor installed ## Setup Open the root of your documentation repository where `docs.json` is located. In the integrated terminal, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Cursor Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. Open a file and use Cursor's AI features to draft and edit documentation. # Windsurf setup Source: https://wiki.diversity.cz/ai-tools/windsurf Configure Windsurf for your documentation workflow Set up Windsurf's Cascade AI assistant to help you write and maintain your Mintlify documentation. ## Prerequisites * Windsurf editor installed ## Setup Open the root of your documentation repository where `docs.json` is located. In the integrated terminal, run: ```bash theme={null} npx skills add https://mintlify.com/docs ``` This gives Windsurf Mintlify's component reference, writing standards, and workflow guidance. Edit `AGENTS.md` in your project root to add project-specific terminology, style preferences, and content boundaries. Open a file and use Cascade to draft and edit documentation. # Create Plant Source: https://wiki.diversity.cz/api-reference/endpoint/create POST /plants Creates a new plant in the store # Delete Plant Source: https://wiki.diversity.cz/api-reference/endpoint/delete DELETE /plants/{id} Deletes a single plant based on the ID supplied # Get Plants Source: https://wiki.diversity.cz/api-reference/endpoint/get GET /plants Returns all plants from the system that the user has access to # New Plant Source: https://wiki.diversity.cz/api-reference/endpoint/webhook WEBHOOK /plant/webhook Information about a new plant added to the store # Introduction Source: https://wiki.diversity.cz/api-reference/introduction 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 theme={null} "security": [ { "bearerAuth": [] } ] ``` # Úvod Source: https://wiki.diversity.cz/cs/dokumenty/uvod # Changelog Source: https://wiki.diversity.cz/cs/informace/changelog Buďte v obraze ohledně nejnovějších aktualizací, nových funkcí, vylepšení platformy, oprav chyb a změn v naší infrastruktuře. ## Oprava kritických zranitelností V Linuxových distribucích se za poslední týden vyskytly kritické exploity přímo v Kernelu, které bylo nutné opravit. Proběhl neplánovaný restart všech serverů a následná oprava, která zajištuje bezpečnost všech zákazníků. * Aktualizace a následné zabezpečení všech serverů. * Posílení bezpečnosti a odstranění nevyužívaných packages. ## Nová znalostní báze Zprovozněna nová Wiki (znalostní báze). Původní Wiki nesplňovala moderní požadavky a postrádala některé funkce. Proběhla také aktualizace starých návodů, primárně návodů, týkajících se Control Panelu. * Aktualizace návodů * Přidání nových informačních stránek ## Přesun starých služeb na novou doménu Dokončení přesunu high priority služeb a aplikací na novou doménu (tzv. z "služba".websiteboys.cz na "služba".diversity.cz). Aktualizace SSL certifikátů na nové certifikáty. * Přesun Control Panelu, PHPMyAdmin, Emailů. * Přesun Status stránky. * Přesun Cloudu. * Přesun interních nástrojů. * Přesun Service clusterů. * Aktualizace certifikátů. ## Posílení firewallů a bezpečnosti V průběhu týdne byla aplikována nová bezpečností pravidla pro všechny naše servery. Proběhlo výrazné "čištění" zbytečných portů a původních služeb. * Aktualizace pravidel na server-side firewallech. * Přidání externích firewallů. * Aktualizace všech serverů a bezpečnostních pravidel. * Přidány globální limity pro pokusy na přihlášení. * Přidání globálních php.ini pravidel. * Přidání HTTPS enforce na všech službách. # Managed Webhosting Source: https://wiki.diversity.cz/cs/managed_webhosting Zapomeňte na složité nastavování a technickou správu serverů. My se postaráme o techniku, abyste se vy mohli plně soustředit na rozvoj svých projektů. Dejte sbohem nepřehledné správě a předraženým tarifům. Díky našemu intuitivnímu panelu spravujete všechny své weby na jednom místě - svobodně, bezpečně a bez omezujících balíčků. **Podporované verze PHP**: 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.4, 7.3, 7.2, 7.1, 7.0, 5.6, 5.2, 5.3, 5.4 a 5.5 Toto řešení doporučujeme pokud spravujete několik stránek, nebo pokud Vám stránky například vytváříme ale máte zájem o extra výkon a dedikovaný prostor pro Vaše projekty. ## Jak to funguje? * **Výběr balíčku:** Při zřizování se s Vámi domluvíme na balíčku, který Vám bude vyhovovat. Na základě toho do 48 hodin zpřístupníme Váš server na našem Control Panelu. Vy se poté jen přihlásíte na náš Panel a přidáte si 1 nebo více stránek. * **Napojení na náš intuitivní panel:** Po připojení serveru k našemu panelu získáte plnou kontrolu nad vytvářením a správou svých webových stránek. Nabízíme staging stránky, to jsou dočasné stránky pod naší doménou určené pro prototypování, tyto stránky lze vytvořit do několika vteřin. * **Libovolné počty stránek:** Potřebujete jeden web, nebo jich chcete provozovat desítky? Naše služba umožňuje snadno spravovat libovolný počet stránek přímo z jednoho místa. Počet webových stránek je samozřejmě omezen výkonem, proto Vám pomůžeme vybrat balíček, který bude vyhovovat Vašim požadavkům. * **Automatizované procesy:** Instalace CMS (WordPress, WooCommerce, Joomla) je otázkou několika kliknutí. Součástí jsou také automatické zálohy. ```mermaid theme={null} graph TD A[Výběr tarifu] --> B[Příprava serveru do 24h] B --> C[Automatické napojení na náš panel] C --> D{Vaše správa} D --> E[Vytvoření webu a CMS] D --> F[Správa e-mailů a DNS] D --> G[Staging a testování] style C fill:#0010FC,color:#fff,stroke:#333 ``` ## Nabídka balíčků Nabízíme rozsáhlé možnosti serverů, postaráme se o napojení a do 24h bude Váš prostor připraven přímo na našem panelu. Každý server má možnost zálohování jednotlivých webových stránek (na serverový disk). Součástí je emailový server pro všechny webové stránky, DNS a nechybí ani databáze. Všechny služby jsou omezeny maximálním výkonem a uložištěm daného balíčku. Máte o některý z balíčků zájem, nebo chcete jenom cenovou nabídku? Ozvěte se nám na email [**kontakt@diversity.cz**](mailto:kontakt@diversity.cz) VPS Hosting nabízí výkon, který si rozdělujete jen mezi svými stránkami, není sdílen mezi ostatními zákazníky. Což znamená, že se výkon rovnoměrně rozprostře mezi Vaše stránky. VDS Hosting nabízí nejvyšší výkon, který si rozdělujete jen mezi svými stránkami, není sdílen mezi ostatními zákazníky. Což znamená, že se výkon rovnoměrně rozprostře mezi Vaše stránky. VDS navíc využívá plně dedikovaný hardware pro maximální výkon. Je určen primárně pro běh velmi náročných aplikací, popřípadě pro několik desítek webových stránek. Pokud chcete nejvyšší možný výkon, tohle je balíček právě pro Vás. ### Česká republika - VPS * **DIV-VPS-CZ-01:** 1x vCPU, 2 GB ECC RAM (DDR4), 25 GB NVMe SSD\*, 1x IPv4. * **DIV-VPS-CZ-02:** 2x vCPU, 4 GB ECC RAM (DDR4), 50 GB NVMe SSD\*, 1x IPv4. * **DIV-VPS-CZ-03:** 4x vCPU, 8 GB ECC RAM (DDR4), 80 GB NVMe SSD\*, 1x IPv4. ### Německo - VPS * **DIV-VPS-DE-01:** 2x vCPU, 4 GB ECC RAM (DDR4), 40 GB NVMe SSD\*, 1x IPv4. * **DIV-VPS-DE-02:** 4x vCPU, 8 GB ECC RAM (DDR4), 80 GB NVMe SSD\*, 1x IPv4. * **DIV-VPS-DE-03:** 8x vCPU, 16 GB ECC RAM (DDR4), 160 GB NVMe SSD\*, 1x IPv4. * **DIV-VPS-DE-04:** 16x vCPU, 32 GB ECC RAM (DDR4), 320 GB NVMe SSD\*, 1x IPv4. ### Německo - VDS * **DIV-VDS-DE-01:** 4x CPU AMD (EPYC), 16 GB ECC RAM (DDR4), 160 GB NVMe SSD\*, 1x IPv4, konektivita 1 GBit/s. * **DIV-VDS-DE-02:** 8x CPU AMD (EPYC), 32 GB ECC RAM (DDR4), 240 GB NVMe SSD\*, 1x IPv4, konektivita 1 GBit/s. * **DIV-VDS-DE-02:** 16x CPU AMD (EPYC), 64 GB ECC RAM (DDR4), 360 GB NVMe SSD\*, 1x IPv4, konektivita 1 GBit/s. \*Udávaná velikost uložiště je před instalací operačního systému a potřebného softwaru pro napojení na náš Control Panel. Konečná velikost uložiště se může lišit od udávané velikosti. ## Doplňkové služby * Dodatečná IPv4 nebo IPv6 * Externí zálohy * Navýšení diskové kapacity ## Lokalita Zakládáme si na rychlosti a zabezpečení. Proto naše servery najdete v klíčových uzlech: **v Praze, Brně a v německém pohraničí**, což zajišťuje bleskovou odezvu pro celou střední Evropu. **Proč nabízíme servery i v Německu?** Využíváme špičkovou německou infrastrukturu v těsné blízkosti ČR pro kombinaci vysokého výkonu a nízké latence, což se obvykle vyplatí, pokud se cílová skupina nachází i mimo ČR nebo v krajích sousedících s Německem. ## Webové servery * **Apache** (standardní systém, pro statické stránky i WordPress, podporuje .htaccess) * **Nginx** (standardní systém, pro statické stránky i WordPress, nepodporuje .htaccess, FastCGI, Cache, Rewrite Rules zabudované v našem panelu) * **OpenLiteSpeed** (optimalizovaný systém, vhodný převážně pro WordPress, podporuje pouze .htaccess RewriteRule, Cache, ModSecurity) * **LiteSpeed** (dle [ceníku LiteSpeed Enterprise](https://www.litespeedtech.com/products/litespeed-web-server/lsws-pricing), vysoce optimalizovaný systém, plně podporuje .htaccess, Cache, ModSecurity) # Monitoring Source: https://wiki.diversity.cz/cs/monitoring Monitoring webových stránek.. # SSL Certifikáty Source: https://wiki.diversity.cz/cs/navody/certifikaty SSL (Secure Sockets Layer) certifikát je digitální certifikát, který autentizuje identitu webové stránky a umožňuje šifrované spojení. SSL je standardní bezpečnostní technologie, která zajišťuje, že data přenášená mezi webovým serverem a prohlížečem zůstanou soukromá a neporušená. ## Proč je SSL certifikát důležitý? 1. **Šifrování**: SSL certifikáty šifrují data přenášená mezi serverem a klientem, což chrání citlivé informace před zachycením třetími stranami. 2. **Autentizace**: Certifikát potvrzuje, že webová stránka je opravdu tím, za co se vydává, což zvyšuje důvěryhodnost. 3. **SEO Výhody**: Vyhledávače, jako Google, preferují stránky zabezpečené pomocí SSL a mohou jim dávat vyšší hodnocení. 4. **Důvěra uživatelů**: Webové stránky s SSL certifikátem ukazují ikonu zámku v adresním řádku, což zvyšuje důvěru návštěvníků. ## Jak používat certifikáty? Pokud jsme správce Vašich stránek a domény, nemusíte se o nic starat, bezpečí zajišťujeme instalací Cloudflare certifikátu, který dovolí ověřování Server → Cloudflare a každé 3 měsíce vygeneruje automaticky nový certifikát. Img4 Pokud si stránky spravujete sami, jsou 2 primární možnosti: * **Let's Encrypt Certifikát** - automaticky vygenerovaný certifikát, který se při správném nasměrování domény automaticky obnovuje každé 2-3 měsíce. * **Vlastní SSL Certifikát** - vyžaduje manuální instalaci certifikátu, pokud využíváte Cloudflare, nahrajete svůj Client Certificate. Img2 Po požádání o **Let's Encrypt Certifikát** stačí vyčkat několik vteřin a certifikát se automaticky obnoví. Pro správnou funkčnost a automatizaci Let's Encrypt certifikátů je potřebné mít správně nakonfigurovanou doménu. Přičemž musí být nasměrována na náš Panel. # Databáze Source: https://wiki.diversity.cz/cs/navody/databaze V našem **Panelu** můžete snadno spravovat své databáze MySQL nebo MariaDB. Každá databáze běží izolovaně v rámci kontejneru vašeho webu. Img5 ## Vytvoření nové databáze Vytvoření databáze je v **Control Panelu** rozděleno na dva kroky: vytvoření samotného datového úložiště a vytvoření uživatele s přístupovými právy. 1. Přihlaste se do **Panelu**. 2. V sekci **"Websites"** vyberte doménu, u které chcete databázi spravovat. 3. V postranním menu zvolte položku **"Databases"**. 4. Klikněte na tlačítko **"Add Database"**. 5. Zadejte název databáze. * *Upozornění: Systém k názvu automaticky přidává unikátní prefix (např. `u123_`), který nelze odstranit.* Img7 ## Správa databázových uživatelů Aby se vaše aplikace (např. WordPress nebo Node.js) mohla k datům připojit, musíte vytvořit uživatele a přiřadit mu práva. 1. V záložce **"Databases"** sjeďte k části **"Database Users"**. 2. Klikněte na **"Add Database User"**. 3. Zadejte uživatelské jméno a vygenerujte si silné heslo. 4. **Přiřazení:** Jakmile uživatele vytvoříte, musíte jej u dané databáze vybrat a udělit mu oprávnění (obvykle "All Privileges"). ## Připojovací údaje (Localhost) Pokud vaše aplikace běží na stejném serveru jako hosting (standardní nastavení), použijte tyto údaje: * **Host (Hostitel):** `localhost` nebo `127.0.0.1` * **Port:** `3306` * **Database Name:** Celý název včetně prefixu (např. `u123_mojedatabaze`) * **Username:** Celé jméno uživatele včetně prefixu (např. `u123_admin`) ## PhpMyAdmin Pro rychlou úpravu tabulek, import nebo export dat využijte integrovaný nástroj phpMyAdmin. * V sekci **"Databases"** najdete u každé databáze tlačítko **"PhpMyAdmin"**. * Kliknutím budete automaticky a bezpečně přihlášeni do webového rozhraní pro správu dat. Img9 ## Vzdálený přístup (Remote Access) Ve výchozím stavu jsou databáze přístupné pouze zevnitř serveru přes `localhost`. Pokud se potřebujete připojit z externího programu: 1. U konkrétního databázového uživatele v **Panelu** klikněte na editaci. 2. V části **"Allowed Hosts"** přidejte svou veřejnou **IP adresu**. 3. Jako Hostitele ve svém lokálním programu pak použijte IP adresu našeho serveru. Z bezpečnostních důvodů nikdy nepovolujte přístup pro všechny adresy (znak `%`). Vždy povolujte pouze konkrétní IP adresu svého počítače nebo kanceláře. ## Diskové kvóty Mějte na paměti, že velikost databáze se započítává do celkového diskového prostoru vašeho hostingového tarifu. V případě vyčerpání kvóty nebude možné do databáze zapisovat nová data, což může způsobit nefunkčnost webových stránek. # FTP a správa souborů Source: https://wiki.diversity.cz/cs/navody/ftp_soubory Nabízíme připojení ke správě souborů pomocí FTP a také k webovému FTP. V případě některých našich balíčků nabízíme také SSH přístup. # Co je to FTP a jak funguje? FTP (File Transfer Protocol) je protokol pro přenos souborů mezi počítači v síti, jako je internet. Pomocí FTP můžete nahrávat, stahovat a spravovat soubory na vašem webovém serveru. FTP je užitečné pro údržbu webových stránek, protože umožňuje snadný přístup k souborům, jejich úpravu a správu. # Vytvoření FTP účtu 1. **Přihlaste se** do svého ovládacího panelu. 2. V levém menu klikněte na sekci **"Weby"**. 3. Vyberte doménu, pro kterou chcete FTP účet vytvořit. 4. V menu - sekci "**Pokročilé**" najděte a rozklikněte položku **"FTP"**. 5. Klikněte na tlačítko **"Přidat účet"**. Img23 6. Uživatelské jméno: jméno, kterým se budete přihlašovat, za jméno se automaticky vyplní *@název-domény*. 7. Heslo: heslo pro přihlášená ke konkrétnímu FTP účtu 8. Adresář: klasicky pracovní adresář webu, pro jednodušší procházení lze vyplnit `/public_html`. Img24 9. Kliknete na tlačítko **"Přidat"** a účet se vytvoří. 10. Po rozkliknutí FTP účtu se Vám zobrazí informace pro připojení. Img25 # Jak se připojit k serveru přes FTP Pro připojení k vašemu serveru přes FTP budete potřebovat následující údaje: **FTP server**: Adresa vašeho FTP serveru (například [ftp.diversity.cz](https://ftp.diversity.cz) nebo IP adresa serveru, například 1.1.1.1) **Uživatelské jméno**: Vaše FTP uživatelské jméno **Heslo**: Vaše FTP heslo **Port**: 21, v případě SFTP - 22 Existuje mnoho FTP klientů, které můžete použít. Mezi oblíbené patří FileZilla, WinSCP nebo Cyberduck. V následujících krocích budeme používat FileZillu a WinSCP jako příklad. Nezapomeňte si ve vašem FTP vybrat správný editor souborů. Váš editor musí podporovat UTF-8 aby se předešlo uložení webu a smazání nebo záměně znaků, které jiné kódování nepodporuje. ## FileZilla **Krok 1**: Otevřete FTP klienta a vyplňte přihlašovací údaje * Otevřete FileZillu. * Do políčka Hostitel zadejte adresu vašeho FTP serveru. * Do políčka Uživatelské jméno zadejte vaše FTP uživatelské jméno. * Do políčka Heslo zadejte vaše FTP heslo. * Port ponechte prázdný nebo zadejte 21, pokud to není automaticky nastaveno. * Klikněte na Rychlé připojení. **Krok 2**: Přenos souborů * Po připojení se zobrazí dvě okna: **Levé okno**: Soubory a složky na vašem počítači. **Pravé okno**: Soubory a složky na vašem serveru. Pro nahrání souborů přetáhněte soubory z levého okna do pravého okna. Pro stažení souborů přetáhněte soubory z pravého okna do levého okna. ## WinSCP **Krok 1**: Otevřete FTP klienta a vyplňte přihlašovací údaje * Otevřete WinSCP. * Klikněte na nové místo. * Jako přenosový protokol vyberte FTP (port 21). * Do políčka Hostitel zadejte adresu vašeho FTP serveru. * Do políčka Uživatelské jméno zadejte vaše FTP uživatelské jméno. * Do políčka Heslo zadejte vaše FTP heslo. * Klikněte na Přihlásit. **Krok 2**: Přenos souborů * Po připojení se zobrazí dvě okna: **Levé okno**: Soubory a složky na vašem počítači. **Pravé okno**: Soubory a složky na vašem serveru. Pro nahrání souborů přetáhněte soubory z levého okna do pravého okna. Pro stažení souborů přetáhněte soubory z pravého okna do levého okna. ## Webové FTP Poskytujeme také webové rozhraní pro FTP, které umožňuje správu souborů přímo z webového prohlížeče bez potřeby instalace dalšího softwaru. Img21 * Otevřete svůj webový prohlížeč a přihlaste se do administrátorského panelu. * V administrátorském panelu najděte nástroj pro správu souborů (pod názvem "Files" nebo "Správce souborů"). * Pomocí tohoto nástroje můžete procházet strukturu souborů na vašem webu, nahrávat nové soubory, stahovat existující soubory, přejmenovávat soubory a složky, mazat je nebo upravovat přímo v prohlížeči. * Ve složce public\_html naleznete soubory vašich webových stránek, pokud budete web nahrávat, umístěte ho do složky public\_html ve které dále můžete pracovat. * Při rozkliknutí daného souboru se otevře vestavěný editor, pomocí kterého můžete jednoduše upravit soubor. Img22 # Instalace aplikací Source: https://wiki.diversity.cz/cs/navody/instalace-aplikaci Náš **Control Panel** obsahuje knihovnu vestavěných aplikací, které jsou přímo integrovány do systému. Tyto aplikace můžete nainstalovat během několika vteřin bez nutnosti stahovat instalační soubory nebo manuálně konfigurovat databáze. ## Dostupné aplikace Přímo v **Panelu** si můžete vybrat z těchto prověřených systémů: * **WordPress:** Nejoblíbenější systém pro tvorbu webových stránek a blogů. * **WooCommerce + WordPress:** Kompletní řešení pro váš e-shop postavené na WordPressu s předinstalovaným modulem WooCommerce. * **Joomla:** Flexibilní redakční systém pro rozsáhlé portály a firemní prezentace. ## Jak nainstalovat aplikaci Instalace je plně automatizovaná a probíhá přímo v rozhraní daného webu. V **Control Panelu** přejděte do sekce **"Weby"** a klikněte na doménu, u které chcete aplikaci spustit. V ovládacím menu webu zvolte položku **"Aplikace"**. Zde uvidíte seznam aplikací (pokud jsou nějaké nainstalované). Tlačítko **"Instalovat aplikaci"** otevře menu, kde zadáváte údaje pro instalaci. Img13 Vyberte aplikaci (např. **WordPress**). Systém vás požádá o zadání: * **Doména:** Doména, na které aplikace poběží. * **Uživatelské jméno:** Vaše přihlašovací jméno pro správu webu. * **Emailová adresa**: Administrátorský email pro správu webu. * **Heslo:** Heslo pro přihlášení na web. Klikněte na tlačítko pro potvrzení. **Panel** automaticky vytvoří kontejner, databázi, uživatele a nahraje potřebné soubory. Po skončení procesu se můžete ihned přihlásit do administrace webu. Img14 ## Výhody vestavěných aplikací Proč používat náš instalátor místo ručního nahrávání? * **Rychlost:** Instalace je hotová do minuty. * **Bezpečnost:** Systém instaluje vždy nejnovější stabilní verzi. * **Vše v jednom:** Nemusíte ručně vytvářet databázi – **Panel** ji vytvoří a propojí za vás. * **Staging (Klonování):** U těchto aplikací můžete v **Panelu** jedním kliknutím vytvořit testovací kopii webu. Pokud chcete mít web přímo na hlavní doméně (např. `test.dev.iversity.cz`), nechte políčko **"Directory"** nebo **"Path"** prázdné. Pokud tam napíšete například `shop`, web poběží na adrese `test.dev.diversity.cz/shop`. ## Aktualizace a správa Pravidelné aktualizace jsou základem bezpečnosti. U všech vestavěných aplikací můžete v sekci **"Installations"** vidět aktuální verzi a v případě dostupnosti nové verze provést update přímo z **Panelu**. Před každou velkou aktualizací doporučujeme provést zálohu webu, abyste se v případě potíží s pluginy mohli snadno vrátit k funkční verzi. Img15 Sekce **"WordPress uživatelé"** umožňuje snadnou správu uživatelů přímo v **Panelu**, zároveň může sloužit pro obnovení zapomenutého hesla. Img16 V sekci **"Pluginy"** lze spravovat a popřípadě instalovat pluginy z veřejné WordPress knihovny nebo z odkazu. Img17 Sekce **"Instalace pluginů"** umožňuje procházení veřejných pluginů, lze procházet z několika kategorií a nebo použít funkci hledání. Img18 # Napojení domény Source: https://wiki.diversity.cz/cs/navody/napojeni_domeny Připojení domény k webhostingu je klíčovým krokem při vytváření webových stránek. Pokud ještě nemáte registrovanou doménu, budete si ji muset zakoupit u registrátora domén. Populární registrátoři zahrnují společnosti jako GoDaddy, Namecheap. My doporučujeme použít české společnosti jako Forpsi, Wedos nebo Active24. Pokud pro Vás web vytváříme my, o napojení domény se starat nemusíte, vše za Vás zařídíme my. # Použití externího poskytovatele Zde si ukážeme jak nasměrovat doménu na náš webhosting. Aby se při zadání doménového jména načetl web správně. ## Wedos Pokud máte doménu zaregistrovanou například u poskytovatele Wedos, nemusíte měnit DNS servery. Stačí přejít do "DNS záznamy" případně "Editovat DNS záznamy". Klikneme na tlačítko "Nový záznam". 1. Tím že doména budeme používat celou doménu (př. [diversity.cz](https://diversity.cz)), název necháme prázdný. 2. TTL ponecháme "výchozí". 3. Typ zvolíme "A". 4. Do políčka data napíšeme IP adresu poskytovatele (hostingu), tuto adresu najdete v administrativním panelu. 5. Kliknete na "Uložit záznam". 6. Přidáte další záznam skrze stejný postup s rozdílem že v názvu bude "www", znovu uložte změny. 7. Nyní stačí kliknout na "Aplikovat změny". 8. Na našem panelu rozkliknete požadovaný server a kliknete na "Domény" nebo "Domains". 9. Poté na "Přidat doménu" nebo "Add domain". 10. Následně vyplníte políčko "Doména" nebo "Domain", zadáte název vaší domény. 11. Nakonec kliknete na tlačítko "Přidat" nebo "Add". 12. Do několika minut by web měl být přístupný skrze doménu. ## Cloudflare (doporučeno) Pokud máte doménu zaregistrovanou nebo napojenou na poskytovatele Cloudflare. Rozklikněte si danou doménu a klikněte na "DNS records". Poté klikneme na tlačítko "Add record". 1. Typ bude "A". 2. Do Name zadáme buď @ nebo celý název naší domény. 3. Do IPv4 address zadáme adresu IP adresu poskytovatele (hostingu), tuto adresu najdete v administrativním panelu. 4. Proxy status necháte na "Proxied" (bude svítit "oranžový mráček"). 5. TTL ponecháme na "Auto". 6. Nakonec klikneme na "Save". 7. Přidáme ještě jeden záznam podle stejného postupu s rozdílem že v názvu bude "www". 8. Do několika minut by měly být aplikované změny a web by měl být přístupný skrze doménu. Změna DNS může trvat několik minut až hodin. # Použití našich DNS serverů Aby bylo možné spravovat DNS záznamy přímo v našem rozhraní, je nutné u vaší domény nastavit směrování na naše jmenné servery. 1. Přihlaste se do administrace u svého registrátora domény. 2. U správy konkrétní domény zvolte změnu DNS serverů. 3. Jako **NSSET** (identifikátor sady jmenných serverů) zadejte: [**DIVERSITY**](https://www.nic.cz/whois/nsset/DIVERSITY/) Po uložení změny může trvat 6 až 24 hodin, než se nové nastavení projeví po celém světě. Pokud se jedná o jinou, než .CZ doménu, nenastavujete NSSET ale přímo DNS servery, v takovém případě nastavíte **ns1.diversity.cz** a **ns2.diversity.cz** # Node.js aplikace Source: https://wiki.diversity.cz/cs/navody/node-js Náš panel umožňuje snadné nasazení Node.js aplikací. Každá aplikace běží ve svém vlastním kontejneru, což zajišťuje vysokou bezpečnost a stabilitu. Node.js aplikace jsou dostupné u balíčků **Business a Ultimate**, nebo v rámci individuálních Managed řešení. ## Vytvoření webové stránky Před nasazením samotné aplikace musíte vytvořit prostor, kde poběží. 1. Přihlaste se do svého ovládacího panelu. 2. Klikněte na **"Weby"** a poté na **"Přidat web"**. 3. Zadejte svou doménu. 4. V hlavní sekci vyberte z nabídky: **Začít od nuly**. ## Konfigurace Node.js Jakmile je web vytvořen, rozklikněte jej a přejděte na záložku **"Node.js"** která se nachází v sekci **"Pokročilé"**. Po kliknutí na "**Nasazení aplikace"** uvidíte následující nastavení: Img28 * **Node Version**: Vyberte požadovanou verzi Node.js (doporučujeme používat **LTS** verze pro maximální stabilitu). * **Pracovní adresář**: Cesta k hlavní složce aplikace (obvykle `/public_html` nebo kořenový adresář). * **Spouštěcí příkaz**: Příkaz, který aplikaci spouští (např. `npm start`). * **Port**: Port, na kterém běží vaše aplikace uvnitř kontejneru (obvykle `3000`). Img29 Panel bude přesměrovávat požadavky na konkrétní cestu (nebo celý web) do vaší aplikace Node.js běžící uvnitř kontejneru webu. Jelikož každý kontejner webu má izolovaný síťový stack, stačí, aby byl port jedinečný v rámci daného webu. Nelze použít port menší než 1024 nebo větší než 65535. Náš systém automaticky směruje provoz na HTTPS port. Což znamená, že po nasazení aplikace můžete jít rovnou na instalovanou doménu a zobrazit si web bez nutnosti zadávání portu. ## Nahrání kódu a instalace modulů Své soubory nahrajte pomocí **FTP** nebo přes **File Manager** (viz návod na FTP). Poté musíte nainstalovat závislosti (balíčky) definované ve vašem `package.json`. Nahrajte svůj kód do zvoleného "Application Root". Ujistěte se, že nahráváte i soubor `package.json`. V panelu u nastavení Node.js najdete tlačítko **"Run npm install"**. To automaticky stáhne všechny potřebné moduly do složky `node_modules`. Klikněte na tlačítko **"Start"** nebo **"Restart"**. Aplikace se spustí na pozadí jako služba. ## Provozní režimy (Automatic vs. Manual) V našem panelu si můžete vybrat ze dvou režimů běhu aplikace podle toho, zda aplikaci ladíte, nebo už je plně v provozu. ### 1. Automatický režim (Doporučeno pro produkci) Tento režim je navržen pro stabilní běh vašeho projektu. * **Automatický start:** Aplikace se spustí sama s vybranou verzí Node.js. * **Restart při pádu:** Pokud aplikace z jakéhokoliv důvodu skončí (chyba, pád serveru), náš panel ji okamžitě restartuje. * **Logování:** Výstupy `Stdout` a `Stderr` se ukládají do souboru v domovském adresáři ve formátu `persistent_app_ID.log`. Tento log se promazává (cykluje) při každém startu aplikace. * **Jak restartovat:** Pokud potřebujete aplikaci vynuceně restartovat, přepněte režim z *Automatic* na *Manual* a hned zase zpět. ### 2. Manuální režim (Pro vývoj a ladění) V tomto režimu panel aplikaci nehlídá ani nespouští. * **Ruční ovládání:** Pokud aplikace spadne, zůstane vypnutá, dokud ji sami nespustíte. * **Bez logů:** V tomto režimu se negenerují automatické logy do souboru. * **Proxy:** I v manuálním režimu bude náš server nadále přesměrovávat požadavky na vaši aplikaci (pokud je to povoleno). ## Správa a logování Pokud vaše aplikace nefunguje podle očekávání, nejužitečnější informace najdete v **.log** souborech. * **App Logs**: Přímo v panelu můžete sledovat konzoli své aplikace. To je klíčové pro ladění chyb (např. chybějící moduly nebo špatné připojení k databázi). * **Automatický restart**: Pokud aplikace spadne, systém se ji pokusí automaticky restartovat (pokud je nastavena na **Automaticky - Produkční režim**). ## Tipy pro produkci * **Package-lock.json**: Vždy nahrávejte i tento soubor, abyste zajistili, že se v produkci nainstalují přesně ty samé verze balíčků, které máte u sebe v počítači. * **Statické soubory**: Pokud vaše aplikace slouží i statické soubory (obrázky, CSS), doporučujeme pro optimální výkon použít Nginx jako reverzní proxy (již nastaveno v základu panelu). Nikdy nenahrávejte složku `node_modules` přímo přes FTP. Je to pomalé a může to způsobit nekompatibilitu mezi operačními systémy. Vždy instalujte pomocí příkazu přímo z SSH. # Průvodce panelem Source: https://wiki.diversity.cz/cs/navody/pruvodce_panelem Vítejte ve svém **Panelu**. Zde můžete spravovat veškeré aspekty svého hostingu – od souborů a databází až po e-maily a výkon serveru. Tento průvodce vám ukáže hlavní sekce, které budete při své práci nejčastěji používat. ## 1. Dashboard (Přehled) Pro přihlášení na **Control Panel** navštivte webovou adresu [panel.diversity.cz](https://panel.diversity.cz). Img1 Hned po přihlášení uvidíte hlavní nástěnku. * **Webové stránky:** Najdete zde seznam Vašich webových stránek. * **Statistiky:** Rychlý přehled o využití RAM, CPU a diskového prostoru. * **Aktivita:** Seznam posledních akcí, které byly na vašem účtu provedeny. Img27 ## 2. Sekce Weby (Webové stránky) ### 1. Aplikace Zde najdete vestavěný instalátor aplikací. Jedním kliknutím zde nainstalujete WordPress, WooCommerce nebo Joomlu bez nutnosti cokoli stahovat nebo ručně propojovat databázi. ### 2. Soubory Přístup k souborovému WebFTP přímo v prohlížeči. Můžete zde nahrávat obrázky, upravovat kód nebo měnit oprávnění souborů bez nutnosti instalovat FTP klienta. ### 3. Databáze Správa MySQL a MariaDB. Zde vytváříte nové databáze, uživatele a najdete zde také přímý vstup do nástroje **phpMyAdmin** pro pokročilou správu dat. ### 4. Emaily Vše kolem vaší pošty. Vytvářejte si schránky typu `info@test.dev.diversity.cz`, nastavujte automatické přesměrování nebo spravujte antispamovou ochranu. ### 5. Domény Správa doménových jmen, aliasů a ukazatelů. Pokud k webu potřebujete připojit další doménu, uděláte to právě zde. ### 6. Analytika Sledujte výkon svého webu. Najdete zde statistiky návštěvnosti a vytížení serveru, abyste měli přehled o tom, jak se vašemu projektu daří. ### 7. Zálohy Sekce pro bezpečí vašich dat. Zde najdete automatické zálohy a u tarifů **Business** a **Ultimate** zde můžete vytvářet i ruční zálohy před velkými změnami na webu. ### 8. Zabezpečení Správa SSL certifikátů (HTTPS). Zde si aktivujete bezplatný certifikát Let's Encrypt nebo nahrajete svůj vlastní. *** ## Pokročilé nastavení Pod záložkou **"Pokročilé"** v pravé části menu najdete specifické nástroje: * **Přesměrování:** Snadné nastavení přesměrování z jedné URL na druhou (301/302). * **Optimalizace:** Nastavení cache a dalších prvků pro zrychlení načítání webu. * **FTP:** Správa FTP účtů a přístupových údajů pro externí klienty (FileZilla, WinSCP). * **Vývojářské nástroje:** Přístup k pokročilým funkcím pro programátory. * **Node.js \[Novinka]:** Kompletní správa aplikací běžících v prostředí Node.js. *** ## Vyhledávání a usnadnění V horní části **Panelu** najdete globální vyhledávání. Stačí začít psát název domény nebo funkce a systém vás okamžitě navede na správné místo. Většina nastavení v **Panelu** se projeví okamžitě. Například po změně PHP verze nebo přidání domény není třeba čekat na restart serveru – změna je aktivní do několika vteřin. # Zálohování Source: https://wiki.diversity.cz/cs/navody/zalohovani Bezpečnost vašich dat je pro nás prioritou. Náš **Control Panel** obsahuje robustní systém zálohování, který chrání vaše soubory i databáze před nečekanými událostmi nebo chybnými úpravami. ## Automatické zálohy Všechny naše hostingové tarify obsahují **automatické zálohování**. Systém pravidelně v noci vytváří kopii celého vašeho webu (soubory + databáze + emaily). Po vytvoření webu je první záloha vytvořena nejdříve po 15 minutách. * **Frekvence:** Zálohy se provádějí automaticky bez nutnosti vašeho zásahu. * **Retence:** Držíme historii záloh za několik posledních dní, abyste se mohli v případě potřeby vrátit k funkční verzi. * **Umístění:** Zálohy jsou ukládány na oddělený diskový prostor, aby neovlivňovaly výkon vašeho webu. Img37 ## Ruční zálohy (On-demand) Potřebujete vytvořit zálohu právě teď – například před instalací nového pluginu nebo velkou aktualizací? Funkce **ručního zálohování** (On-demand backup) vám umožní vytvořit okamžitý bod obnovy. Funkce ručního zálohování je dostupná výhradně pro tarify **Business a Ultimate**. **Jak vytvořit ruční zálohu:** 1. V **Panelu** přejděte do sekce **"Weby"** a vyberte svůj web. 2. V menu klikněte na položku **"Zálohy"**. 3. Pokud váš tarif tuto funkci podporuje, uvidíte tlačítko **"Vytvořit zálohu"**. 4. Po dokončení se tato záloha objeví v seznamu s označením "Manual". ## Jak obnovit data ze zálohy Obnova je jednoduchá a zvládnete ji na pár kliknutí přímo v **Control Panelu**. 1. V sekci **"Backups"** uvidíte seznam všech dostupných záloh (automatických i ručních). 2. U každé zálohy máte dvě hlavní možnosti: * **Obnovit:** Obnoví pouze soubory a složky (např. pokud jste si smazali obrázek). * **Obnovit databáze:** Obnoví pouze databázové tabulky (např. pokud se web po aktualizaci rozbil). 3. Po kliknutí na tlačítko obnovy systém začne přepisovat aktuální data daty ze zálohy. Celý proces trvá od několika vteřin po minuty (v závislosti na velikosti webu). **Pozor:** Obnova dat je nevratný proces. Jakmile spustíte obnovu, aktuální stav vašeho webu bude přepsán daty ze zálohy. Pokud máte na webu nové objednávky nebo články vytvořené po datu zálohy, budou přepsány. ## Externí zálohování Pro náročnější projekty nabízíme v rámci doplňkových služeb také **přídavné externí zálohování** na další, geograficky oddělené úložiště. To zajišťuje, že vaše data budou v bezpečí i v případě výpadku celého datového centra. # Úvod Source: https://wiki.diversity.cz/cs/reseni-problemu/uvod # Web Hosting Source: https://wiki.diversity.cz/cs/web-hosting Pro Vaše stránky máme spolehlivý a přizpůsobitelný hosting, který zajistí **bezpečnost** a **dostupnost**. Nabízíme sdílený i dedikovaný server s **automatickými zálohami**, HTTPS podporou a databázemi. Díky stabilní infrastruktuře získáte **rychlý** a **bezproblémový provoz** vašich webových aplikací. Postaráme se o to, aby Váš web měl dostatek výkonu a byl vždy online. Všechny naše servery mají konektivitu 1 GBit/s, což zajišťuje maximální rychlost všech služeb. **Podporované verze PHP**: 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.4, 7.3, 7.2, 7.1, 7.0, 5.6, 5.2, 5.3, 5.4 a 5.5 *** ## Nabízené balíčky Webhostingu Ideální pro jednoduché, popřípadě jednostránkové statické weby. * Automatické zálohy * 1x databáze * 2 GB uložiště * 3 FTP účty * 256 MB php\_memory * Traffic 1 TB / měsíc Vhodné pro středně velké stránky, popřípadě pro redakční systém. * Automatické zálohy, možnost obnovení * 3x databáze * 5 GB uložiště * 10 FTP účtů * 512 MB php\_memory + Swap * Traffic 2 TB / měsíc * 10x emailových účtů (schránek) * Instalátor aplikací (WordPress, WooCommerce, Joomla, Node.JS) * Integrovaný správce WordPressu (základní funkce) Pro náročné aplikace a velké weby, ideální pro redakční systém. * Automatické zálohy, možnost obnovení, manuální zálohy * 5x databáze * 10 GB uložiště * 15 FTP účtů * 1024 MB php\_memory + Swap * Traffic 5 TB / měsíc * 20x emailových účtů (schránek) * Instalátor aplikací (WordPress, WooCommerce, Joomla, Node.JS) * Integrovaný správce WordPressu * SSH přístup Pro rozsáhlé redakční systémy a aplikace. * Automatické zálohy * 10x databáze * 20 GB uložiště * 30 FTP účtů * 2048 MB php\_memory + swap * Traffic 10 TB / měsíc * 50x emailových účtů (schránek) * Instalátor aplikací (WordPress, WooCommerce, Joomla, Node.JS) * Integrovaný správce WordPressu * SSH přístup **Pro hosting ULTIMATE nabízíme doménu na první rok zdarma. Můžete si vybrat mezi doménami: .cz, .sk, .eu, .xyz, .store, .site, .website, .space, .art** *** ## Ceník Webhostingu ### LITE * 70 Kč / měsíc ### PREMIUM * 120 Kč / měsíc ### BUSINESS * 210 Kč / měsíc ### ULTIMATE * 360 Kč / měsíc **Uvedená cena je konečná a platí při roční fakturaci. Pokud máte zájem o speciální balíček, vytvořený přímo na míru, kontaktujte nás.** *** ### Doplňkové služby Nabízíme také doplňky... *** ## Dedikovaný Webhosting Máte náročnou webovou stránku a chcete, aby měla dedikovaný výkon? K tomu Vám poslouží náš dedikovaný Webhosting, který zaručí 100% výkon pro Váš web. Pokud máte zájem o dedikovaný hosting, kontaktujte nás! # Development Source: https://wiki.diversity.cz/development Preview changes locally to update your docs **Prerequisites**: * Node.js version 19 or higher * A docs repository with a `docs.json` file Follow these steps to install and run Mintlify on your operating system. ```bash theme={null} npm i -g mint ``` Navigate to your docs directory where your `docs.json` file is located, and run the following command: ```bash theme={null} mint dev ``` A local preview of your documentation will be available at `http://localhost:3000`. ## Custom ports By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. For example, to run Mintlify on port 3333, use this command: ```bash theme={null} mint dev --port 3333 ``` If you attempt to run Mintlify on a port that's already in use, it will use the next available port: ```md theme={null} Port 3000 is already in use. Trying 3001 instead. ``` ## Mintlify versions Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI: ```bash theme={null} npm mint update ``` ## Validating links The CLI can assist with validating links in your documentation. To identify any broken links, use the following command: ```bash theme={null} mint broken-links ``` ## Deployment If the deployment is successful, you should see the following: Screenshot of a deployment confirmation message that says All checks have passed. ## Code formatting We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting. ## Troubleshooting This may be due to an outdated version of node. Try the following: 1. Remove the currently-installed version of the CLI: `npm remove -g mint` 2. Upgrade to Node v19 or higher. 3. Reinstall the CLI: `npm i -g mint` Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again. Curious about what changed in the latest CLI version? Check out the [CLI changelog](https://www.npmjs.com/package/mintlify?activeTab=versions). / # Code blocks Source: https://wiki.diversity.cz/essentials/code Display inline code and code blocks ## 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 blocks 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 theme={null} class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` ````md theme={null} ```java HelloWorld.java class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` ```` ## Code groups To display the same snippet in multiple languages as tabs, use the `CodeGroup` component. See [Components](/essentials/components#code-groups) for usage. # Components Source: https://wiki.diversity.cz/essentials/components Callouts, cards, steps, tabs, and more Mintlify components let you build rich, interactive documentation pages using MDX. Here are some commonly used ones. See the [components overview](https://mintlify.com/docs/components) in the Mintlify documentation for a complete list. ## Callouts Use callouts to draw attention to important information. A **Note** is for general information that helps the reader. A **Tip** highlights a helpful shortcut or best practice. A **Warning** flags something that could cause problems. An **Info** callout provides supplementary context. ```mdx theme={null} A **Note** is for general information that helps the reader. A **Tip** highlights a helpful shortcut or best practice. A **Warning** flags something that could cause problems. An **Info** callout provides supplementary context. ``` ## Cards Cards link readers to other pages or resources. Auto-generated docs from your OpenAPI spec. Get your docs running in three steps. ```mdx theme={null} Auto-generated docs from your OpenAPI spec. Get your docs running in three steps. ``` Use `` to control the grid width. Cards without `href` render as informational panels. ## Steps Steps present numbered procedures clearly. ```bash theme={null} npm install my-package ``` Run the init command in your project root. ```bash theme={null} npx my-package init ``` Start using the package in your code. ````mdx theme={null} ```bash npm install my-package ``` Run the init command in your project root. Start using the package in your code. ```` ## Tabs Tabs let readers switch between alternative content — different languages, environments, or platforms. ```bash theme={null} npm install my-package ``` ```bash theme={null} yarn add my-package ``` ```bash theme={null} pnpm add my-package ``` ````mdx theme={null} ```bash npm install my-package ``` ```bash yarn add my-package ``` ```bash pnpm add my-package ``` ```` ## Accordions Accordions collapse content behind a toggle — useful for FAQs or optional detail. A brief answer to the first question. Keep it concise. Another answer here. Use as much space as you need. ```mdx theme={null} A brief answer to the first question. Another answer here. ``` ## Frames Wrap images or other content in a `Frame` to add a styled border and rounded corners. Big Bend landscape ```mdx theme={null} App screenshot ``` ## Code groups `CodeGroup` displays multiple code snippets as tabs — ideal for showing the same example in multiple languages. ```typescript TypeScript theme={null} const response = await fetch('https://api.example.com/users'); const users = await response.json(); ``` ```python Python theme={null} import requests response = requests.get('https://api.example.com/users') users = response.json() ``` ```bash curl theme={null} curl https://api.example.com/users ``` ````mdx theme={null} ```typescript TypeScript const response = await fetch('https://api.example.com/users'); ``` ```python Python response = requests.get('https://api.example.com/users') ``` ```` # Images and embeds Source: https://wiki.diversity.cz/essentials/images Add image, video, and other HTML elements ## Image ### Using Markdown The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code ```md theme={null} ![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 theme={null} ``` ## Embeds and HTML elements ``` # Markdown syntax Source: https://wiki.diversity.cz/essentials/markdown Text, title, and styling in standard markdown ## Titles Best used for section headers. ```md theme={null} ## Titles ``` ### Subtitles Best used for subsection headers. ```md theme={null} ### 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 theme={null} > 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 theme={null} > 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 theme={null} 8 x (vk x H1 - H2) = (0,1) ``` # Navigation Source: https://wiki.diversity.cz/essentials/navigation The navigation field in docs.json defines the pages that go in the navigation menu 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 theme={null} "navigation": { "tabs": [ { "tab": "Docs", "groups": [ { "group": "Getting Started", "pages": ["quickstart"] } ] } ] } ``` ```json Nested Navigation theme={null} "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 theme={null} "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. # Reusable snippets Source: https://wiki.diversity.cz/essentials/reusable-snippets Write once, reuse everywhere. Use snippets to keep content in sync across pages Any content you find yourself repeating across pages is a good candidate for a snippet. Create the file once in the `snippets/` directory, import it wherever you need it, and updates propagate everywhere automatically. Files inside `snippets/` are not rendered as standalone pages. They only appear where you import them. ## Content snippets The simplest pattern: write MDX content in a snippet file and import it as a component. ```mdx snippets/prerequisites.mdx theme={null} Before you begin, make sure you have: - Node.js 18 or higher - An API key from your [dashboard](https://dashboard.example.com) ``` Import it into any page using a root-relative path: ```mdx your-page.mdx theme={null} --- title: Install the SDK --- import Prerequisites from '/snippets/prerequisites.mdx'; ## Installation ... ``` You can also use relative imports, which enables CMD+click navigation to the snippet in your editor: ```mdx theme={null} import Prerequisites from '../snippets/prerequisites.mdx'; ``` ## Variable snippets Export named constants from a snippet file to reuse values like product names, version numbers, or URLs. ```mdx snippets/vars.mdx theme={null} export const sdkVersion = '3.2.0'; export const baseUrl = 'https://api.example.com/v1'; ``` Import and use them inline: ```mdx your-page.mdx theme={null} import { sdkVersion, baseUrl } from '/snippets/vars.mdx'; The current SDK version is **{sdkVersion}**. All requests go to `{baseUrl}`. ``` ## Component snippets For snippets that need to vary based on where they're used, export an arrow function component that accepts props. ```mdx snippets/endpoint-note.mdx theme={null} export const EndpointNote = ({ method, path }) => ( This guide covers the {method} {path} endpoint. See the API reference for full details. ); ``` * Use arrow function syntax (`const Foo = () => ...`). * The `function` keyword is not supported in snippet files. * MDX syntax doesn't compile inside arrow function bodies. Use plain HTML tags there, or use a default export instead. Pass props when you render it: ```mdx your-page.mdx theme={null} import { EndpointNote } from '/snippets/endpoint-note.mdx'; ``` ## Snippets importing snippets Snippets can import other snippets, which is useful for composing larger shared sections from smaller pieces. ```mdx snippets/auth-intro.mdx theme={null} import AuthNote from '/snippets/auth-note.mdx'; ## Authentication All endpoints require a bearer token. ``` # Configuration Source: https://wiki.diversity.cz/essentials/settings Customize your site with the `docs.json` file Every Mintlify site is configured through a `docs.json` file in your project root. Changes take effect immediately in local preview. ## Identity Set the name, theme, and visual identity of your site. ```json docs.json theme={null} { "name": "Acme Docs", "theme": "mint", "favicon": "/favicon.svg", "logo": { "light": "/logo/light.svg", "dark": "/logo/dark.svg" } } ``` Your project name. Appears in the browser tab title and site metadata. The visual theme. Options: `mint`, `maple`, `willow`, `sequoia`, `prism`. Path to your favicon. SVG recommended for crisp rendering at all sizes. Logo shown in light mode. Logo shown in dark mode. URL the logo links to. ## Colors ```json docs.json theme={null} { "colors": { "primary": "#16A34A", "light": "#07C983", "dark": "#15803D" } } ``` Primary brand color. Used for highlights, active states, and accents in light mode. Primary color for dark mode. Used for buttons and important interactive elements. Override the default page background color. Background hex color in light mode. Background hex color in dark mode. ## Navbar Configure the top navigation bar links and primary call-to-action. ```json docs.json theme={null} { "navbar": { "links": [ { "label": "Support", "href": "mailto:support@example.com" } ], "primary": { "type": "button", "label": "Dashboard", "href": "https://dashboard.example.com" } } } ``` Text links displayed in the top navigation bar. Display text for the link. URL the link points to. The prominent call-to-action in the top-right corner. `button` renders a CTA button. `github` renders a star count badge. Button label. Required when type is `button`. URL the button or badge links to. ## Navigation Organize your pages into tabs and groups. See the [Navigation](/essentials/navigation) guide for full details. ```json docs.json theme={null} { "navigation": { "tabs": [ { "tab": "Guides", "groups": [ { "group": "Getting started", "pages": ["index", "quickstart"] } ] } ], "global": { "anchors": [ { "anchor": "Blog", "href": "https://example.com/blog", "icon": "newspaper" } ] } } } ``` ## Contextual toolbar The contextual toolbar floats on every page and gives readers one-click access to AI tools and integrations. See [Contextual toolbar](/agent-ready/contextual) for the full list of options. ```json docs.json theme={null} { "contextual": { "options": ["copy", "view", "claude", "mcp", "cursor", "vscode"] } } ``` ## Footer ```json docs.json theme={null} { "footer": { "socials": { "x": "https://x.com/yourhandle", "github": "https://github.com/yourorg", "linkedin": "https://linkedin.com/company/yourco" } } } ``` Social links shown in the footer. Supported keys: `x`, `github`, `linkedin`, `discord`, `slack`, `facebook`, `instagram`, `website`. # Úvod Source: https://wiki.diversity.cz/index Vítejte na naší znalostní bázi (Wiki) Tato wiki slouží jako centrální místo pro všechny technické návody, informace o našem hostingu a pomoc při správě vašich projektů. ## Hlavní oblasti Vyberte si kategorii, kterou hledáte: Všechny technické postupy pro nastavení domén, FTP přístupů a správu vašich Node.js aplikací. Rychlá pomoc v případě chybových hlášení, problémů s připojením nebo potíží se SSL certifikáty. Přehled všech dostupných hostingových tarifů, jejich technické parametry a doplňkové služby. Všeobecné obchodní podmínky, zásady ochrany osobních údajů (GDPR) a další legislativa. ## Nejoblíbenější návody Rychlé odkazy na to, co naši zákazníci hledají nejčastěji: *** ## Máte dotaz? Pokud zde nenajdete odpověď na svou otázku, neváhejte nás kontaktovat přímo na [kontakt@diversity.cz](mailto:kontakt@diversity.cz). Zpět na hlavní stránky. Prohlédněte si služby, které nabízíme, reference od našich zákazníků a mnoho dalšího. # Quickstart Source: https://wiki.diversity.cz/quickstart Start building awesome documentation in minutes ## Get started in three steps Get your documentation site running locally and make your first customization. ### Step 1: Set up your local environment During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com). To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs. 1. Install the Mintlify CLI: `npm i -g mint` 2. Navigate to your docs directory and run: `mint dev` 3. Open `http://localhost:3000` to see your docs live! Your preview updates automatically as you edit files. ### Step 2: Deploy your changes Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app). Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself. For a first change, let's update the name and colors of your docs site. 1. Open `docs.json` in your editor. 2. Change the `"name"` field to your project name. 3. Update the `"colors"` to match your brand. 4. Save and see your changes instantly at `http://localhost:3000`. Try changing the primary color to see an immediate difference! ### Step 3: Go live 1. Commit and push your changes. 2. Your docs will update and be live in moments! ## Next steps Now that you have your docs running, explore these key features: Learn MDX syntax and start writing your documentation. Make your docs match your brand perfectly. Include syntax-highlighted code blocks. Auto-generate API docs from OpenAPI specs. **Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).