Skip to content

Commit

Permalink
3043: Clarify theme-original and theme-init
Browse files Browse the repository at this point in the history
  • Loading branch information
@Jonathannsegal
Jonathannsegal committed Jul 24, 2020
1 parent 9fab79c commit 85edcc5
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/api-pages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 plusin'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`:
Expand Down

0 comments on commit 85edcc5

Please sign in to comment.