From 805adc2c35eab787d69699346a0b6bb732d7da9f Mon Sep 17 00:00:00 2001 From: Jonathan Date: Tue, 11 Aug 2020 05:29:07 -0500 Subject: [PATCH] docs(v2): clarify theme-original and theme-init (#3111) * 3043: Clarify theme-original and theme-init * Update docs/api-pages.md Co-authored-by: Drew Alexander Co-authored-by: Drew Alexander --- docs/api-pages.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api-pages.md b/docs/api-pages.md index f636c29b7652..3cbc105412a1 100644 --- a/docs/api-pages.md +++ b/docs/api-pages.md @@ -83,6 +83,8 @@ What this means to the user is that if you wish to use the `CompLibrary` module, If you wish to use your own components inside the website directory, use `process.cwd()` which will refer to the `website` directory to construct require paths. For example, if you add a component to `website/core/mycomponent.js`, you can use the require path, `'process.cwd() + /core/mycomponent.js'`. +There is a special import for custom items `@theme-original`. The `theme-original` alias (just like using `theme` alias) will not get the theme component from the plugin's code. While the `init-theme` alias refers to the proper (theme) component (from the theme itself, where it is first defined). Therefore the `theme-original` is for the user and `theme-initial` is for the plugins. + ## Provided Components Docusaurus provides the following components in `CompLibrary`: