Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

This plug-in conflict with i18n #163

Closed
juansalvatore opened this issue Feb 2, 2023 · 1 comment
Closed

This plug-in conflict with i18n #163

juansalvatore opened this issue Feb 2, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@juansalvatore
Copy link

juansalvatore commented Feb 2, 2023

Please describe the bug you are seeing

Is this library still maintained?

This issue was already reported and I don't know if there's a known way to make the library work?

image

image

How can we best reproduce the bug?

same as the other bug reports.

Which version of Docusaurus and @cmfcmf/docusaurus-search-local are you using?

"@cmfcmf/docusaurus-search-local": "0.11.0",
"@docusaurus/core": "2.3.0",
"@docusaurus/mdx-loader": "2.3.0",
"@docusaurus/preset-classic": "2.3.0",

Which Node.js version are you using?

Node version: v18.0.0

Which theme are you using?

Yes, I am using @docusaurus/theme-classic

How does your plugin config look like?

const config = {
  title: "",
  tagline: "",
  url,
  baseUrl,
  onBrokenLinks: "warn",
  onBrokenMarkdownLinks: "warn",
  favicon: "img/favicon/favicon.png",
  trailingSlash: true,
  organizationName: "", // Usually your GitHub org/user name.
  projectName: "", // Usually your repo name.

  customFields: {
    isNodeEnvProd,
    isNodeEnvDev,
    sentryDsn,
  },

  plugins: [
    async function (context, options) {
      return {
        name: "postcss-tailwindcss-loader",
        configurePostCss(postcssOptions) {
          postcssOptions.plugins.push(require("tailwindcss"), require("autoprefixer"));

          return postcssOptions;
        },
      };
    },
    [
      require.resolve("@cmfcmf/docusaurus-search-local"),
      {
        // 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: false,

        // 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/
        // When you want to overwrite CSS variables defined by the default theme, make sure to suffix your
        // overwrites with `!important`, because they might otherwise not be applied as expected. See the
        // following comment for more information: https://github.com/cmfcmf/docusaurus-search-local/issues/107#issuecomment-1119831938.
        style: undefined,

        // The maximum number of search results shown to the user. This does _not_ affect performance of
        // searches, but simply does not display additional search results that have been found.
        maxSearchResults: 8,

        // 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,
          tagsBoost: 3,
          parentCategoriesBoost: 2, // Only used when indexDocSidebarParentCategories > 0
        },
      },
    ],
  ],

  presets: [
    [
      "@docusaurus/preset-classic",
      /** @type {import('@docusaurus/preset-classic').Options} */
      ({
        docs: {
          // editUrl: 'https://github.com/zeta-chain/zeta-docs',
          routeBasePath: "/",
          sidebarPath: require.resolve("./sidebars.js"),
          showLastUpdateTime: true,
          include: ["**/*.md", "**/*.mdx"],
        },
        blog: false,
        theme: {
          customCss: require.resolve("./src/css/custom.css"),
        },
        sitemap: {
          changefreq: "weekly",
          priority: 0.5,
        },
      }),
    ],
  ],

  themeConfig:
    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
    {
      colorMode: {
        defaultMode: "dark",
      },
      prism: {
        theme: require("prism-react-renderer/themes/github"),
        darkTheme: require("prism-react-renderer/themes/dracula"),
        additionalLanguages: ["solidity"],
      },
      hideOnScroll: true,
    },
};

Additional context

No response

@juansalvatore juansalvatore added the bug Something isn't working label Feb 2, 2023
@juansalvatore
Copy link
Author

juansalvatore commented Feb 2, 2023

related issues:
#129
starcoinorg/starcoin-cookbook#164

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants