From 7f47fd2bc4c2a7ecf6f2f5e82a66139b2fc7ed91 Mon Sep 17 00:00:00 2001 From: Sarbeh Date: Thu, 7 Dec 2023 16:48:11 +0700 Subject: [PATCH 1/3] docs(i18n): Add Indonesian translation for site search documentation --- .../content/docs/id/guides/site-search.mdx | 168 ++++++++++++++++++ 1 file changed, 168 insertions(+) create mode 100644 docs/src/content/docs/id/guides/site-search.mdx diff --git a/docs/src/content/docs/id/guides/site-search.mdx b/docs/src/content/docs/id/guides/site-search.mdx new file mode 100644 index 0000000000..dd6088849a --- /dev/null +++ b/docs/src/content/docs/id/guides/site-search.mdx @@ -0,0 +1,168 @@ +--- +title: Pencarian Situs +description: Pelajari tentang fitur pencarian situs bawaan Starlight dan cara mengkustomisasinya. +sidebar: + badge: Baru +--- + +import { Tabs, TabItem } from '@astrojs/starlight/components'; + +Secara default, situs Starlight termasuk pencarian teks lengkap yang didukung oleh [Pagefind](https://pagefind.app/), yang merupakan alat pencarian cepat dan bandwidth rendah untuk situs statis. + +Tidak diperlukan konfigurasi untuk mengaktifkan pencarian. Bangun dan terapkan situs Anda, kemudian gunakan bilah pencarian di header situs untuk menemukan konten. + +Kecualikan sebuah halaman + +## Sembunyikan konten dalam hasil pencarian + +### Kecualikan sebuah halaman + +Untuk mengecualikan sebuah halaman dari indeks pencarian Anda, tambahkan [`pagefind: false`](/id/reference/frontmatter/#pagefind) ke frontmatter halaman: + +```md title="src/content/docs/not-indexed.md" ins={3} +--- +title: Content to hide from search +pagefind: false +--- +``` + +### Kecualikan bagian dari sebuah halaman + +Pagefind akan mengabaikan konten di dalam elemen dengan atribut [`data-pagefind-ignore`](https://pagefind.app/docs/indexing/#removing-individual-elements-from-the-index). + +Dalam contoh berikut, paragraf pertama akan ditampilkan dalam hasil pencarian, tetapi isi dari `
` tidak akan: + +```md title="src/content/docs/partially-indexed.md" ins="data-pagefind-ignore" +--- +title: Partially indexed page +--- + +Teks ini akan ditemukan melalui pencarian. + +
+ +Teks ini akan disembunyikan dari pencarian. + +
+``` + +## Penyedia pencarian alternatif + +### Algolia DocSearch + +Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.algolia.com/) dan ingin menggunakannya sebagai gantinya Pagefind, Anda dapat menggunakan plugin DocSearch Starlight resmi. + +1. Install `@astrojs/starlight-docsearch`: + + + + + + ```sh + npm install @astrojs/starlight-docsearch + ``` + + + + + + ```sh + pnpm install @astrojs/starlight-docsearch + ``` + + + + + + ```sh + yarn add @astrojs/starlight-docsearch + ``` + + + + + +2. Tambahkan DocSearch ke konfigurasi [`plugins`](/id/reference/configuration/#plugins) Starlight Anda di astro.config.mjs dan taruh `appId`, `apiKey`, and `indexName` Algolia Anda: + + ```js ins={4,10-16} + // astro.config.mjs + import { defineConfig } from 'astro/config'; + import starlight from '@astrojs/starlight'; + import starlightDocSearch from '@astrojs/starlight-docsearch'; + + export default defineConfig({ + integrations: [ + starlight({ + title: 'Site with DocSearch', + plugins: [ + starlightDocSearch({ + appId: 'YOUR_APP_ID', + apiKey: 'YOUR_SEARCH_API_KEY', + indexName: 'YOUR_INDEX_NAME', + }), + ], + }), + ], + }); + ``` + +Dengan konfigurasi yang diperbarui ini, bilah pencarian di situs Anda sekarang akan membuka modal Algolia sebagai gantinya modal pencarian bawaan. + +#### Menerjemahkan UI DocSearch + +Secara default, DocSearch hanya menyediakan string UI dalam Bahasa Inggris. +Tambahkan terjemahan UI modal untuk bahasa Anda menggunakan [internationalization system](/id/guides/i18n/#translate-starlights-ui) bawaan Starlight. + +1. Perluas definisi koleksi konten `i18n` Starlight dengan skema DocSearch di `src/content/config.ts`: + + ```js ins={4} ins=/{ extend: .+ }/ + // src/content/config.ts + import { defineCollection } from 'astro:content'; + import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; + import { docSearchI18nSchema } from '@astrojs/starlight-docsearch/schema'; + + export const collections = { + docs: defineCollection({ schema: docsSchema() }), + i18n: defineCollection({ + type: 'data', + schema: i18nSchema({ extend: docSearchI18nSchema() }), + }), + }; + ``` + +2. Tambahkan terjemahan ke file JSON Anda di `src/content/i18n/`. + +Ini adalah default Bahasa Inggris yang digunakan oleh DocSearch: + + ```json title="src/content/i18n/en.json" + { + "docsearch.searchBox.resetButtonTitle": "Clear the query", + "docsearch.searchBox.resetButtonAriaLabel": "Clear the query", + "docsearch.searchBox.cancelButtonText": "Cancel", + "docsearch.searchBox.cancelButtonAriaLabel": "Cancel", + + "docsearch.startScreen.recentSearchesTitle": "Recent", + "docsearch.startScreen.noRecentSearchesText": "No recent searches", + "docsearch.startScreen.saveRecentSearchButtonTitle": "Save this search", + "docsearch.startScreen.removeRecentSearchButtonTitle": "Remove this search from history", + "docsearch.startScreen.favoriteSearchesTitle": "Favorite", + "docsearch.startScreen.removeFavoriteSearchButtonTitle": "Remove this search from favorites", + + "docsearch.errorScreen.titleText": "Unable to fetch results", + "docsearch.errorScreen.helpText": "You might want to check your network connection.", + + "docsearch.footer.selectText": "to select", + "docsearch.footer.selectKeyAriaLabel": "Enter key", + "docsearch.footer.navigateText": "to navigate", + "docsearch.footer.navigateUpKeyAriaLabel": "Arrow up", + "docsearch.footer.navigateDownKeyAriaLabel": "Arrow down", + "docsearch.footer.closeText": "to close", + "docsearch.footer.closeKeyAriaLabel": "Escape key", + "docsearch.footer.searchByText": "Search by", + + "docsearch.noResultsScreen.noResultsText": "No results for", + "docsearch.noResultsScreen.suggestedQueryText": "Try searching for", + "docsearch.noResultsScreen.reportMissingResultsText": "Believe this query should return results?", + "docsearch.noResultsScreen.reportMissingResultsLinkText": "Let us know." + } + ``` From d5f39b4204f3617f632d412cbdd471d3af875bd2 Mon Sep 17 00:00:00 2001 From: Sarbeh Date: Fri, 8 Dec 2023 11:46:17 +0700 Subject: [PATCH 2/3] docs: refine translation based on review feedback --- .../content/docs/id/guides/site-search.mdx | 32 +++++++++---------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/docs/src/content/docs/id/guides/site-search.mdx b/docs/src/content/docs/id/guides/site-search.mdx index dd6088849a..e6314261ed 100644 --- a/docs/src/content/docs/id/guides/site-search.mdx +++ b/docs/src/content/docs/id/guides/site-search.mdx @@ -11,17 +11,15 @@ Secara default, situs Starlight termasuk pencarian teks lengkap yang didukung ol Tidak diperlukan konfigurasi untuk mengaktifkan pencarian. Bangun dan terapkan situs Anda, kemudian gunakan bilah pencarian di header situs untuk menemukan konten. -Kecualikan sebuah halaman - ## Sembunyikan konten dalam hasil pencarian ### Kecualikan sebuah halaman Untuk mengecualikan sebuah halaman dari indeks pencarian Anda, tambahkan [`pagefind: false`](/id/reference/frontmatter/#pagefind) ke frontmatter halaman: -```md title="src/content/docs/not-indexed.md" ins={3} +```md title="src/content/docs/tidak-diindeks.md" ins={3} --- -title: Content to hide from search +title: Konten yang Disembunyikan dari Pencarian pagefind: false --- ``` @@ -32,9 +30,9 @@ Pagefind akan mengabaikan konten di dalam elemen dengan atribut [`data-pagefind- Dalam contoh berikut, paragraf pertama akan ditampilkan dalam hasil pencarian, tetapi isi dari `
` tidak akan: -```md title="src/content/docs/partially-indexed.md" ins="data-pagefind-ignore" +```md title="src/content/docs/sebagian-diindeks.md" ins="data-pagefind-ignore" --- -title: Partially indexed page +title: Halaman yang Diindeks Sebagian --- Teks ini akan ditemukan melalui pencarian. @@ -56,33 +54,33 @@ Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.al - + - ```sh + ```sh npm install @astrojs/starlight-docsearch ``` - + - ```sh + ```sh pnpm install @astrojs/starlight-docsearch ``` - + - ```sh + ```sh yarn add @astrojs/starlight-docsearch ``` - + - + -2. Tambahkan DocSearch ke konfigurasi [`plugins`](/id/reference/configuration/#plugins) Starlight Anda di astro.config.mjs dan taruh `appId`, `apiKey`, and `indexName` Algolia Anda: +2. Tambahkan DocSearch ke konfigurasi [`plugins`](/id/reference/configuration/#plugins) Starlight Anda di `astro.config.mjs` dan taruh `appId`, `apiKey`, and `indexName` Algolia Anda: ```js ins={4,10-16} // astro.config.mjs @@ -111,7 +109,7 @@ Dengan konfigurasi yang diperbarui ini, bilah pencarian di situs Anda sekarang a #### Menerjemahkan UI DocSearch Secara default, DocSearch hanya menyediakan string UI dalam Bahasa Inggris. -Tambahkan terjemahan UI modal untuk bahasa Anda menggunakan [internationalization system](/id/guides/i18n/#translate-starlights-ui) bawaan Starlight. +Tambahkan terjemahan UI modal untuk bahasa Anda menggunakan [internationalization system](/id/guides/i18n/#terjemahkan-ui-starlight) bawaan Starlight. 1. Perluas definisi koleksi konten `i18n` Starlight dengan skema DocSearch di `src/content/config.ts`: @@ -132,7 +130,7 @@ Tambahkan terjemahan UI modal untuk bahasa Anda menggunakan [internationalizatio 2. Tambahkan terjemahan ke file JSON Anda di `src/content/i18n/`. -Ini adalah default Bahasa Inggris yang digunakan oleh DocSearch: + Ini adalah default Bahasa Inggris yang digunakan oleh DocSearch: ```json title="src/content/i18n/en.json" { From ff2d9bb39a17906b4f7a966ce2bfd3c6e307b695 Mon Sep 17 00:00:00 2001 From: Sarbeh Date: Fri, 8 Dec 2023 22:25:06 +0700 Subject: [PATCH 3/3] docs: Translate configuration documentation --- docs/src/content/docs/id/guides/site-search.mdx | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/src/content/docs/id/guides/site-search.mdx b/docs/src/content/docs/id/guides/site-search.mdx index e6314261ed..86cab1536a 100644 --- a/docs/src/content/docs/id/guides/site-search.mdx +++ b/docs/src/content/docs/id/guides/site-search.mdx @@ -56,7 +56,7 @@ Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.al - ```sh + ```sh npm install @astrojs/starlight-docsearch ``` @@ -64,7 +64,7 @@ Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.al - ```sh + ```sh pnpm install @astrojs/starlight-docsearch ``` @@ -72,7 +72,7 @@ Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.al - ```sh + ```sh yarn add @astrojs/starlight-docsearch ``` @@ -91,12 +91,12 @@ Jika Anda memiliki akses ke [Algolia’s DocSearch program](https://docsearch.al export default defineConfig({ integrations: [ starlight({ - title: 'Site with DocSearch', + title: 'Situs dengan DocSearch', plugins: [ starlightDocSearch({ - appId: 'YOUR_APP_ID', - apiKey: 'YOUR_SEARCH_API_KEY', - indexName: 'YOUR_INDEX_NAME', + appId: 'ID_APLIKASI_ANDA', + apiKey: 'KUNCI_API_ANDA', + indexName: 'NAMA_INDEX_ANDA', }), ], }),