3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-03 12:17:20 +02:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
* 3043: Clarify theme-original and theme-init

* Update docs/api-pages.md

Co-authored-by: Drew Alexander <drewalexander986@gmail.com>

Co-authored-by: Drew Alexander <drewalexander986@gmail.com>
This commit is contained in:
Jonathan 2020-08-11 05:29:07 -05:00 • committed by GitHub
parent fd403d3f7c
commit 805adc2c35
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/api-pages.md
View file

@ -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`: