Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
614 changes: 393 additions & 221 deletions docs.json

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions id/advanced/dashboard/permissions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Izin Editor
description: Izinkan lebih banyak anggota tim Anda untuk memperbarui docs
---

Anggota tim yang membuat docs awal Anda akan memiliki akses pembaruan ke docs Anda, selama mereka melakukan push ke repo dokumentasi Anda dengan akun GitHub yang sama yang digunakan saat mendaftar untuk Mintlify.

Jika editor lain mencoba memperbarui docs saat menggunakan paket gratis, Anda akan melihat peringatan dalam pemeriksaan git commit Anda.

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>

Dalam detail peringatan pemeriksaan git, Anda akan menemukan tautan untuk meningkatkan paket Anda. Anda juga dapat meningkatkan paket Anda di [dashboard](https://dashboard.mintlify.com) untuk mengaktifkan editor tak terbatas untuk memperbarui docs Anda. Setelah Anda meningkatkan paket, picu pembaruan manual atau push perubahan lain untuk menerapkan pembaruan Anda.

Pelajari lebih lanjut tentang harga kami [di sini](https://mintlify.com/pricing).
105 changes: 105 additions & 0 deletions id/advanced/dashboard/sso.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
---
title: Single Sign-On (SSO)
description: Sesuaikan cara tim Anda dapat masuk ke dasbor admin Anda
---

Gunakan single sign-on ke dasbor Anda melalui SAML dan OIDC. Jika Anda menggunakan Okta atau Google Workspace, kami memiliki dokumentasi khusus penyedia untuk mengatur SSO, tetapi jika Anda menggunakan penyedia lain, silakan hubungi kami!

<Note>
Fungsi SSO tersedia pada paket Enterprise kami.[Hubungi
kami](https://mintlify.com/enterprise) untuk mempelajari lebih lanjut!
</Note>

## Okta

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
Di bawah `Applications`, klik untuk membuat integrasi aplikasi baru menggunakan SAML 2.0.
</Step>

<Step title="Configure integration">
Masukkan yang berikut:

* URL single sign-on (disediakan oleh Mintlify)
* URI Audiens (disediakan oleh Mintlify)
* Format ID Nama: `EmailAddress`
* Pernyataan Atribut:
| Nama | Format nama | Nilai |
| ----------- | ----------- | ---------------- |
| `firstName` | Dasar | `user.firstName` |
| `lastName` | Dasar | `user.lastName` |
</Step>

<Step title="Send us your IdP information">
Setelah aplikasi diatur, navigasi ke tab sign-on dan kirimkan URL metadata kepada kami.
Kami akan mengaktifkan koneksi dari sisi kami menggunakan informasi ini.
</Step>
</Steps>
</Tab>

<Tab title="OIDC">
<Steps>
<Step title="Create an application">
Di bawah `Applications`, klik untuk membuat integrasi aplikasi baru menggunakan OIDC.
Anda harus memilih `Web Application` tipe aplikasi.
</Step>

<Step title="Configure integration">
Pilih tipe grant kode otorisasi dan masukkan URI Pengalihan yang disediakan oleh Mintlify.
</Step>

<Step title="Send us your IdP information">
Setelah aplikasi diatur, navigasi ke tab Umum dan temukan ID klien & rahasia klien.
Mohon berikan kami informasi ini secara aman, bersama dengan URL instansi Okta Anda (misalnya `<your-tenant-name>.okta.com`). Anda dapat mengirimkan ini melalui layanan seperti 1Password atau SendSafely.
</Step>
</Steps>
</Tab>
</Tabs>

## Google Workspace

<Tabs>
<Tab title="SAML">
<Steps>
<Step title="Create an application">
Di bawah `Web and mobile apps`, pilih `Add custom SAML app` dari `Add app` dropdown.

<Frame>
![](/images/gsuite-add-custom-saml-app.png)
</Frame>
</Step>

<Step title="Send us your IdP information">
Salin URL SSO, ID Entitas, dan sertifikat x509 yang disediakan dan kirimkan ke tim Mintlify.

<Frame>
![](/images/gsuite-saml-metadata.png)
</Frame>
</Step>

<Step title="Configure integration">
Pada halaman detail Penyedia layanan, masukkan yang berikut:

* URL ACS (disediakan oleh Mintlify)
* ID Entitas (disediakan oleh Mintlify)
* Format ID Nama: `EMAIL`
* ID Nama: `Basic Information > Primary email`

<Frame>
![](/images/gsuite-sp-details.png)
</Frame>

Pada halaman berikutnya, masukkan pernyataan atribut berikut:

| Atribut Direktori Google | Atribut Aplikasi |
| ------------------------ | ---------------- |
| `First name` | `firstName` |
| `Last name` | `lastName` |

Setelah langkah ini selesai dan pengguna ditugaskan ke aplikasi, beri tahu tim kami dan kami akan mengaktifkan SSO untuk akun Anda!
</Step>
</Steps>
</Tab>
</Tabs>
42 changes: 42 additions & 0 deletions id/advanced/mcp/generate.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: MCP Generator
description: Pelajari cara menyiapkan Server MCP Anda sendiri
icon: 'text-size'
---

<Tip>
Halaman ini didedikasikan untuk menyiapkan Server MCP Anda sendiri. Jika Anda mencari informasi tentang penggunaan Server Mintlify MCP, silakan merujuk ke
[Menginstal dan menggunakan Server Mintlify MCP](/advanced/mcp/quickstart) halaman.
</Tip>

## Memulai

Jalankan `npm i @mintlify/mcp` untuk menginstal `@mintlify/mcp` CLI.

Di [dasbor](https://dashboard.mintlify.com/products/mcp) pergi ke `MCP Server`, di halaman ini alihkan untuk melihat perintah instalasi unik Anda. Ini adalah perintah untuk menginstal Server MCP Anda dengan `@mintlify/mcp` CLI.

<Note>
Pastikan untuk mengalihkan akses OpenAPI untuk memungkinkan server MCP mengakses **semua**
endpoint dalam spesifikasi OpenAPI Anda.
</Note>

## Memulai server MCP secara lokal

<Steps>
<Step title="Install the server through the CLI">
Jalankan perintah berikut untuk menginstal server:

```bash
npx @mintlify/mcp add [your subdomain]
```
</Step>

<Step title="Add the authentication token if applicable">
Jika API Anda memerlukan token autentikasi, beri tahu pelanggan akhir Anda untuk mendapatkannya dan menerapkannya ketika diberikan respons ini: `> What is the Authorization
(basic token)?` Jika tidak, Anda dapat melewati langkah ini.
</Step>

<Step title="Start your MCP server">
Anda sekarang dapat menjalankan: `bash npm --prefix ~/.mcp/[your subdomain] start `
</Step>
</Steps>
97 changes: 97 additions & 0 deletions id/advanced/mcp/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
---
title: Quickstart
description: Menghasilkan server MCP untuk membantu menghubungkan produk Anda ke LLM
---

## Pendahuluan

MCP Generator adalah alat CLI yang menghasilkan server MCP berdasarkan dokumentasi perusahaan Anda & spesifikasi OpenAPI jika tersedia. Ini mengambil dokumentasi Anda dan spesifikasi OpenAPI dan menghasilkan server MCP yang dapat digunakan dengan klien MCP apa pun. MCP Generator disampaikan melalui[paket npm](https://www.npmjs.com/package/mcp) dan menghasilkan server MCP yang dapat digunakan dengan klien MCP apa pun.

Mintlify memungkinkan Anda membuat server MCP yang memungkinkan alat AI berinteraksi dengan dokumentasi Anda dalam skenario kunci berikut:

1. **Docs Q\&A**, mirip dengan AI Chat kami. Ini secara otomatis diaktifkan untuk dokumentasi Anda, tidak diperlukan pengaturan.
2. **Kueri API real-time**, jika Anda memiliki spesifikasi OpenAPI, buka`Mintlify Dashboard > Products > MCP Server` dan klik toggle untuk mengaktifkan spesifikasi OpenAPI Anda.

<Note>
Dengan mengaktifkan toggle OpenAPI, Anda mengizinkan server MCP untuk mengakses
**semua** endpoint dalam spesifikasi OpenAPI Anda.
</Note>

## Instal server MCP

<Tip>
Halaman ini didedikasikan untuk Server MCP Mintlify. Jika Anda mencari informasi tentang cara menghasilkan MCP Anda, silakan lihat halaman[MCP Generator](/advanced/mcp/generate).
</Tip>

## Contoh instalasi dengan server MCP Mintlify

Untuk menggunakan server MCP Mintlify Anda akan memerlukan[kunci API](https://mintlify.com/docs/advanced/rest-api/overview#authentication) dari akun Mintlify Anda. Jika Anda belum memilikinya, navigasikan ke`Settings > API Keys > Chat API Key` dan buat kunci baru.

## Mulai server MCP secara lokal

<Steps>
<Step title="Install the server through the CLI">
Jalankan perintah berikut untuk menginstal server:

```bash
npx @mintlify/mcp add mintlify
```
</Step>

<Step title="Add the authentication token">
Respons berikut akan diberikan setelah menjalankan perintah sebelumnya:

```
> What is the Authorization (basic token)?
```

Menggunakan kunci chat API Anda, salin token autentikasi dan tempelkan ke dalam CLI.
</Step>

<Step title="Start your MCP server">
Anda sekarang dapat menjalankan:

```bash
npm --prefix ~/.mcp/mintlify start
```
</Step>
</Steps>

## Gunakan server Anda dengan Claude

<Note>
Unduh[Aplikasi Desktop Claude](https://claude.ai/download)
</Note>

Setelah Anda menginstal Aplikasi Desktop Claude, ikuti langkah-langkah berikut:

<Steps>
<Step title="Navigate to the Settings > Developer" />

<Step title="Click on Edit Config">
Tambahkan yang berikut ke`claude_desktop_config.json`:

```json
{
"mcpServers": {
"mintlify": {
"command": "npm",
"args": [
"--prefix",
"~/.mcp/mintlify",
"start"
]
}
}
}
```
</Step>

<Step title="If you see the hammer icon, you're all set!">
Jika Anda mengkliknya, Anda akan melihat MCP Tools yang tersedia di server Anda.

<Frame>
![Claude MCP](/images/mcp-with-claude.png)
</Frame>
</Step>
</Steps>
3 changes: 3 additions & 0 deletions id/advanced/rest-api/chat/create-topic.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/topic
---
3 changes: 3 additions & 0 deletions id/advanced/rest-api/chat/generate-message.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /chat/message
---
38 changes: 38 additions & 0 deletions id/advanced/rest-api/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: Overview
---

## Memicu Pembaruan

Anda dapat memanfaatkan REST API untuk memicu pembaruan secara terprogram saat diinginkan.

<Info>
Meskipun kasus penggunaan utama akan menjadi memicu pembaruan, kami akan menambahkan lebih banyak
fungsionalitas ke API seiring waktu. Beri tahu kami apa lagi yang ingin Anda lihat di
[komunitas kami](https://mintlify.com/community)!
</Info>

## Autentikasi

Anda dapat menghasilkan kunci API melalui
[dasbor](https://dashboard.mintlify.com/settings/organization/api-keys). Kunci API tersebut terkait dengan seluruh organisasi dan dapat digunakan di berbagai deployment.

<Frame>
<img src="/images/external-api-key.png" />
</Frame>

## Kunci API Admin

Kunci API Admin digunakan untuk sebagian besar API. Ini digunakan untuk memicu pembaruan melalui [endpoint Pembaruan](/advanced/rest-api/update/trigger).

## Kunci API Chat

API Chat memungkinkan Anda untuk menyematkan pengalaman chat AI yang didasarkan pada dokumentasi Anda dan terus diperbarui ke dalam aplikasi pilihan Anda.

Respons mencakup kutipan sehingga Anda dapat mengarahkan pengguna ke tempat yang tepat untuk mendapatkan bantuan.

<Note>
Token API Chat adalah token publik yang dapat direferensikan dalam kode frontend Anda sedangkan kunci API adalah token sisi server yang harus dijaga kerahasiaannya.
</Note>

Sekarang Anda memiliki kunci API, lihat [contoh](https://github.com/mintlify/discovery-api-example) kami untuk cara menggunakan API untuk AI chat. Anda juga dapat melihat versi yang sudah di-deploy di [chat.mintlify.com](https://chat.mintlify.com).
3 changes: 3 additions & 0 deletions id/advanced/rest-api/update/status.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: GET /project/update-status/{statusId}
---
3 changes: 3 additions & 0 deletions id/advanced/rest-api/update/trigger.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
openapi: POST /project/update/{projectId}
---
75 changes: 75 additions & 0 deletions id/advanced/subpath/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: Cloudflare
description: Host dokumentasi di subpath /docs menggunakan Cloudflare Workers
---

## Buat Cloudflare Worker

Navigasi ke`Workers & Pages > Create application > Create worker`. Anda akan melihat tampilan berikut di mana Anda dapat membuat worker Cloudflare baru.

<Frame>
<img alt="Create a Cloudflare worker" src="/images/cloudflare/worker.png" />
</Frame>

<Warning>
Perlu diingat: Jika penyedia DNS Anda adalah Cloudflare, Anda tidak boleh menggunakan proxying untuk record CNAME
</Warning>

### Tambahkan domain kustom

Setelah worker dibuat, klik`Configure worker`. Navigasi ke worker
`Settings > Triggers`. Klik pada`Add Custom Domain` untuk menambahkan domain yang Anda inginkan ke dalam daftar - kami menyarankan Anda menambahkan kedua versi dengan dan tanpa`www.`
ditambahkan ke domain.

<Frame>
<img alt="Cloudflare worker custom domain" src="/images/cloudflare/custom-domain.png" />
</Frame>

Jika Anda mengalami kesulitan dalam mengatur subdirektori kustom,
[hubungi tim dukungan kami](mailto:[email protected]) dan kami akan membantu Anda melalui proses peningkatan hosting Anda dengan kami.

### Edit Skrip Worker

Klik pada`Edit Code` dan tambahkan skrip berikut ke dalam kode worker.

<Frame>
<img alt="Cloudflare edit code" src="/images/cloudflare/edit-code.png" />
</Frame>

<Tip>
Edit`DOCS_URL` dengan mengganti`[SUBDOMAIN]` dengan subdomain unik Anda dan`CUSTOM_URL` dengan URL dasar situs web Anda.
</Tip>

```javascript
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});

async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// If the request is to the docs subdirectory
if (/^\/docs/.test(urlObject.pathname)) {
// Then Proxy to Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";

let url = new URL(request.url);
url.hostname = DOCS_URL;

let proxyRequest = new Request(url, request);

proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");

return await fetch(proxyRequest);
}
} catch (error) {
// if no action found, play the regular request
return await fetch(request);
}
}
```

Klik pada`Deploy` dan tunggu perubahan tersebar (bisa memakan waktu hingga beberapa jam).
Loading