mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-22 05:27:00 +02:00
feat(website): improve prism themes (#6214)
* feat(website): modify Prism dark theme * update * Use vsDark * update crowdin config * fix light theme as well * revert comment changes
This commit is contained in:
parent
ae9f43fbc0
commit
96dbb8e7ef
10 changed files with 221 additions and 73 deletions
|
@ -125,7 +125,7 @@ my-website
|
|||
│ └── pages
|
||||
│ ├── styles.module.css
|
||||
│ ├── index.js
|
||||
| ├──_ignored.js
|
||||
│ ├──_ignored.js
|
||||
│ └── support
|
||||
│ ├── index.js
|
||||
│ └── styles.module.css
|
||||
|
|
|
@ -26,13 +26,13 @@ You can display images in three different ways: Markdown syntax, CJS require, or
|
|||
|
||||
Display images using simple Markdown syntax:
|
||||
|
||||
```mdx
|
||||
```md
|
||||

|
||||
```
|
||||
|
||||
Display images using inline CommonJS `require` in JSX image tag:
|
||||
|
||||
```mdx
|
||||
```jsx
|
||||
<img
|
||||
src={require('./assets/docusaurus-asset-example-banner.png').default}
|
||||
alt="Example banner"
|
||||
|
@ -41,10 +41,10 @@ Display images using inline CommonJS `require` in JSX image tag:
|
|||
|
||||
Display images using ES `import` syntax and JSX image tag:
|
||||
|
||||
```mdx
|
||||
```jsx
|
||||
import myImageUrl from './assets/docusaurus-asset-example-banner.png';
|
||||
|
||||
<img src={myImageUrl} alt="Example banner" />
|
||||
<img src={myImageUrl} alt="Example banner" />;
|
||||
```
|
||||
|
||||
This results in displaying the image:
|
||||
|
@ -65,14 +65,10 @@ If you are using [@docusaurus/plugin-ideal-image](../../api/plugins/plugin-ideal
|
|||
|
||||
In the same way, you can link to existing assets by requiring them and using the returned url in videos, links, etc.
|
||||
|
||||
```mdx
|
||||
```md
|
||||
# My Markdown page
|
||||
|
||||
<a
|
||||
target="_blank"
|
||||
href={require('./assets/docusaurus-asset-example.docx').default}>
|
||||
Download this docx
|
||||
</a>
|
||||
<a target="\_blank" href={require('./assets/docusaurus-asset-example.docx').default}> Download this docx </a>
|
||||
|
||||
or
|
||||
|
||||
|
|
|
@ -120,25 +120,18 @@ Create `crowdin.yml` in `website`:
|
|||
|
||||
```yml title="crowdin.yml"
|
||||
project_id: '123456'
|
||||
api_token_env: 'CROWDIN_PERSONAL_TOKEN'
|
||||
api_token_env: CROWDIN_PERSONAL_TOKEN
|
||||
preserve_hierarchy: true
|
||||
files: [
|
||||
# JSON translation files
|
||||
{
|
||||
source: '/i18n/en/**/*',
|
||||
translation: '/i18n/%two_letters_code%/**/%original_file_name%',
|
||||
},
|
||||
# Docs Markdown files
|
||||
{
|
||||
source: '/docs/**/*',
|
||||
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%',
|
||||
},
|
||||
# Blog Markdown files
|
||||
{
|
||||
source: '/blog/**/*',
|
||||
translation: '/i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%',
|
||||
},
|
||||
]
|
||||
files:
|
||||
# JSON translation files
|
||||
- source: /i18n/en/**/*
|
||||
translation: /i18n/%two_letters_code%/**/%original_file_name%
|
||||
# Docs Markdown files
|
||||
- source: /docs/**/*
|
||||
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
|
||||
# Blog Markdown files
|
||||
- source: /blog/**/*
|
||||
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-blog/**/%original_file_name%
|
||||
```
|
||||
|
||||
Crowdin has its own syntax for declaring source/translation paths:
|
||||
|
|
|
@ -109,7 +109,7 @@ Use the `--messagePrefix '(fr) '` option to make the untranslated strings stand
|
|||
|
||||
Copy your untranslated Markdown files to the French folder:
|
||||
|
||||
```
|
||||
```bash
|
||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current
|
||||
cp -r docs/** i18n/fr/docusaurus-plugin-content-docs/current
|
||||
|
||||
|
|
|
@ -172,7 +172,7 @@ npm install --save docusaurus-plugin-sass sass
|
|||
|
||||
2. Include the plugin in your `docusaurus.config.js` file:
|
||||
|
||||
```jsx {3} title="docusaurus.config.js"
|
||||
```js {3} title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
// ...
|
||||
plugins: ['docusaurus-plugin-sass'],
|
||||
|
@ -186,7 +186,7 @@ module.exports = {
|
|||
|
||||
You can now set the `customCss` property of `@docusaurus/preset-classic` to point to your Sass/SCSS file:
|
||||
|
||||
```jsx {8} title="docusaurus.config.js"
|
||||
```js {8} title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
presets: [
|
||||
[
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue