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.

Sign up for GitHub

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

Jump to bottom

docs(v2): clarify theme-original and theme-init #3111

Merged
merged 2 commits into from
Aug 11, 2020
Merged

docs(v2): clarify theme-original and theme-init #3111

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85edcc5
3043: Clarify theme-original and theme-init
Jonathannsegal Jul 24, 2020
2df953b
Update docs/api-pages.md
Jonathannsegal Aug 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/api-pages.md
View file
Open in desktop
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 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`:
Expand Down