All Projects → cmfcmf → docusaurus-search-local

cmfcmf / docusaurus-search-local

Licence: MIT license
Offline / Local Search for Docusaurus v2. Try it live at:

Programming Languages

javascript
184084 projects - #8 most used programming language
typescript
32286 projects

Projects that are alternatives of or similar to docusaurus-search-local

electronjs.org-new
No description or website provided.
Stars: ✭ 16 (-92.12%)
Mutual labels:  docusaurus
archimedes-docs
Give me a place to stand, and I shall move the earth.
Stars: ✭ 15 (-92.61%)
Mutual labels:  docusaurus
remark-admonitions
Add admonitions support to Remarkable
Stars: ✭ 90 (-55.67%)
Mutual labels:  docusaurus
generator-create-docusaurus
A generator for new docusaurus projects.
Stars: ✭ 13 (-93.6%)
Mutual labels:  docusaurus
upptime.js.org
⬆️📝 Documentation and landing page for Upptime
Stars: ✭ 42 (-79.31%)
Mutual labels:  docusaurus
support
Your go-to guides for understanding Hashnode a little better.
Stars: ✭ 36 (-82.27%)
Mutual labels:  docusaurus
mr-pdf
PDF generator of document website
Stars: ✭ 58 (-71.43%)
Mutual labels:  docusaurus
graphql-markdown
Flexible GraphQL Documentation Generator (Markdown)
Stars: ✭ 74 (-63.55%)
Mutual labels:  docusaurus
documentation
Revolt documentation website.
Stars: ✭ 20 (-90.15%)
Mutual labels:  docusaurus
rdfshape-api
API for validating and transforming RDF, ShEx, SHACL and more.
Stars: ✭ 31 (-84.73%)
Mutual labels:  docusaurus
pedax
Reversi Board with edax, which is the strongest reversi engine.
Stars: ✭ 18 (-91.13%)
Mutual labels:  docusaurus
PrimeXT
Modern SDK for Xash3D FWGS engine, uses PhysX for physics, has advanced OpenGL renderer with a lot of features. Crossplatform, supported Windows/Linux. Based on XashXT and Spirit Of Half-Life.
Stars: ✭ 65 (-67.98%)
Mutual labels:  docusaurus
Beauty-Saurus
🦖 Beautiful Docusaurus ✨ Easy-Starter ✨ Project
Stars: ✭ 47 (-76.85%)
Mutual labels:  docusaurus
Remarkable
Markdown parser, done right. Commonmark support, extensions, syntax plugins, high speed - all in one. Gulp and metalsmith plugins available. Used by Facebook, Docusaurus and many others! Use https://github.com/breakdance/breakdance for HTML-to-markdown conversion. Use https://github.com/jonschlinkert/markdown-toc to generate a table of contents.
Stars: ✭ 5,252 (+2487.19%)
Mutual labels:  docusaurus
frontatish
A React native common components kit and helper methods,find the package at this link https://www.npmjs.com/package/frontatish
Stars: ✭ 14 (-93.1%)
Mutual labels:  docusaurus
docker-docusaurus
A docker image for running Docusaurus 2, which is a development version yet, based on lightweight Alpine Linux.
Stars: ✭ 21 (-89.66%)
Mutual labels:  docusaurus
docusaurus-theme-search-typesense
A fork of the awesome @docusaurus/theme-search-algolia library customized to work with Typesense
Stars: ✭ 31 (-84.73%)
Mutual labels:  docusaurus
website
📺Verdaccio documentation website
Stars: ✭ 35 (-82.76%)
Mutual labels:  docusaurus
search-all-tabs
search all opened tabs in a browser popup and see the matching previews using Xapain or Lunrjs engines.
Stars: ✭ 48 (-76.35%)
Mutual labels:  lunrjs
WEB CodeSquare AmongUs
군 복무중인 개발자를 위한 국방망용 통합 개발 플랫폼
Stars: ✭ 42 (-79.31%)
Mutual labels:  docusaurus

Offline / Local Search for Docusaurus v2.0.0-beta.17+

Version License code style: prettier GitHub issues GitHub last commit

Offline / local search for Docusaurus v2.0.0-beta.17+ that works behind your firewall.

Feature Highlights:

  • Supports multiple documentation versions
  • Supports documentation written in languages other than English
  • Highlights search results
  • Customized parsers for docs, blogs, and general pages
  • Lazy-loads the index

Search in Action

Note: We use the open source algolia/autocomplete library for the searchbox. This library is just used as the frontend, and, unlike the default Docusaurus search experience (algolia/docsearch), does not connect to any Algolia or third-party servers.

Installation

yarn add @cmfcmf/docusaurus-search-local

or

npm install @cmfcmf/docusaurus-search-local

Usage

Add this plugin to the plugins array in docusaurus.config.js.

module.exports = {
  // ...
  plugins: [require.resolve("@cmfcmf/docusaurus-search-local")],

  // or, if you want to specify options:

  // ...
  plugins: [
    [
      require.resolve("@cmfcmf/docusaurus-search-local"),
      {
        // Options here
      },
    ],
  ],
};

The following options are available (defaults are shown below):

{
  // whether to index docs pages
  indexDocs: true,

  // Whether to also index the titles of the parent categories in the sidebar of a doc page.
  // 0 disables this feature.
  // 1 indexes the direct parent category in the sidebar of a doc page
  // 2 indexes up to two nested parent categories of a doc page
  // 3...
  //
  // Do _not_ use Infinity, the value must be a JSON-serializable integer.
  indexDocSidebarParentCategories: 0,

  // whether to index blog pages
  indexBlog: true,

  // whether to index static pages
  // /404.html is never indexed
  indexPages: false,

  // language of your documentation, see next section
  language: "en",

  // setting this to "none" will prevent the default CSS to be included. The default CSS
  // comes from autocomplete-theme-classic, which you can read more about here:
  // https://www.algolia.com/doc/ui-libraries/autocomplete/api-reference/autocomplete-theme-classic/
  style: undefined,

  // lunr.js-specific settings
  lunr: {
    // When indexing your documents, their content is split into "tokens".
    // Text entered into the search box is also tokenized.
    // This setting configures the separator used to determine where to split the text into tokens.
    // By default, it splits the text at whitespace and dashes.
    //
    // Note: Does not work for "ja" and "th" languages, since these use a different tokenizer.
    tokenizerSeparator: /[\s\-]+/,
    // https://lunrjs.com/guides/customising.html#similarity-tuning
    //
    // This parameter controls the importance given to the length of a document and its fields. This
    // value must be between 0 and 1, and by default it has a value of 0.75. Reducing this value
    // reduces the effect of different length documents on a term’s importance to that document.
    b: 0.75,
    // This controls how quickly the boost given by a common word reaches saturation. Increasing it
    // will slow down the rate of saturation and lower values result in quicker saturation. The
    // default value is 1.2. If the collection of documents being indexed have high occurrences
    // of words that are not covered by a stop word filter, these words can quickly dominate any
    // similarity calculation. In these cases, this value can be reduced to get more balanced results.
    k1: 1.2,
    // By default, we rank pages where the search term appears in the title higher than pages where
    // the search term appears in just the text. This is done by "boosting" title matches with a
    // higher value than content matches. The concrete boosting behavior can be controlled by changing
    // the following settings.
    titleBoost: 5,
    contentBoost: 1,
    parentCategoriesBoost: 2, // Only used when indexDocSidebarParentCategories > 0
  }
}

You can now use the search bar to search your documentation.

Important: Search only works for the statically built documentation (i.e., after you ran yarn build in your documentation folder).

Search does not work in development (i.e., when running yarn start).

Non-English Documentation

Use the language option if your documentation is not written in English. You can either specify a single language or an array of multiple languages. The following languages are available:

ar, da, de, en, es, fi, fr, hi, hu, it, ja, nl, no, pt, ro, ru, sv, th, tr, vi, zh

Important: For Chinese language support (zh), you also have to install the nodejieba npm package at ^2.5.0.

Documentation Versions

Documentation versions created with the official Docusaurus docs plugin are supported. The search bar defaults to the latest version (not next, but the latest version defined in versions.json) when not on a documentation page (e.g., when looking at a blog post or a static page). If the user visits a documentation page, the version is extracted from the page and search will only search the documentation of that version. The searchbar placeholder text always reflects the currently detected documentation version.

Internationalization

This plugin supports documentation using Docusaurus i18n out of the box.

However, the text used for the searchbox itself (e.g., the Search... placeholder) is currently only translated in German, English, Italian, Portuguese, Brazilian Portuguese, French, Spanish, Japanese, Chinese, and Bahasa Indonesia. Please contribute additional translations by creating a new translation file in the codeTranslations subfolder and submitting a PR.

You can also adjust translations by modifiying the translations in <yourfolder>/i18n/<locale>/code.json that start with cmfcmf/d-s-l.. Read more at: https://docusaurus.io/docs/i18n/tutorial#translate-json-files

Debugging

If building your documentation produces an error, you can build it in debug mode to figure out which page is causing it. To do so, simply set the DEBUG environment variable when building your documentation: DEBUG=1 yarn build.

CONTRIBUTING

Please see the CONTRIBUTING.md file for further information.

License

MIT

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].