Translate

Enabling Search

도큐사우르스에서는 Algolia 문서 검색 기능을 지원합니다. 여러분의 웹사이트가 온라인 상태라면 DocSearch에 요청하기를 할 수 있습니다. Algolia에서 인증 코드를 보내주면 siteConfig.js 파일에 추가합니다.

DocSearch는 매일 24시간동안 여러분의 웹사이트 콘텐츠를 수집해서 Algolia 인덱스에 모든 콘텐츠를 추가합니다. 여러분의 웹사이트에서 Algolia API를 사용해 수집된 콘텐츠에 대해 질의를 던질 수 있습니다. Note that your website needs to be publicly available for this to work (ie. 방화벽 뒤에 감추어져 있으면 안됩니다). 이 서비스는 무료입니다.

검색창 활성화하기

siteConfig.js 파일의 algolia 항목에서 API 키와 인덱스명(Algolia에서 보내준)을 입력하면 웹사이트에서 검색 기능을 사용할 수 있습니다.

const siteConfig = {
  ...
  algolia: {
    apiKey: 'API 키값',
    indexName: '인덱스명',
    algoliaOptions: {} // Algolia에서 받은 옵션값이 있는 경우 사용
  },
  ...
};

Extra Search Options

You can also specify extra search options used by Algolia by using an algoliaOptions field in algolia. This may be useful if you want to provide different search results for the different versions or languages of your docs. Any occurrences of "VERSION" or "LANGUAGE" will be replaced by the version or language of the current page, respectively. More details about search options can be found here.

const siteConfig = {
  ...
  algolia: {
    ...
    algoliaOptions: {
      facetFilters: [ "language:LANGUAGE", "version:VERSION" ]
    }
  },
};

Algolia might provide you with extra search options. If so, you should add them to the algoliaOptions object.

Controlling the Location of the Search Bar

By default, the search bar will be the rightmost element in the top navigation bar.

If you want to change the default location, add the searchBar flag in the headerLinks field of siteConfig.js in your desired location. For example, you may want the search bar between your internal and external links.

const siteConfig = {
  ...
  headerLinks: [
    {...}
    {...}
    { search: true }
    {...}
    {...}
  ],
  ...
};

Customizing the placeholder

If you want to change the placeholder (which defaults to Search), add the placeholder field in your config. For example, you may want the search bar to display Ask me something:

const siteConfig = {
  ...
  algolia: {
    ...
    placeholder: 'Ask me something'
  },
};

Disabling the Search Bar

To disable the search bar, comment out (recommended) or delete the algolia section in the siteConfig.js file.

Also, if you have customized the location of the search bar in headerLinks, set search: false.