mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-28 00:17:14 +02:00
* feat(v2): add ability default lang for code blocks * Add support for CodeBlock * changelog * more changelog * Add checks * docs * docs * Fix changelog * revert config * Update theme-classic.md * Update packages/docusaurus-theme-classic/src/theme/CodeBlock/index.js Co-Authored-By: Endi <endiliey@gmail.com>
1.8 KiB
1.8 KiB
id | title |
---|---|
theme-classic | Classic Theme Configuration |
This section is a work in progress.
Navbar
Navbar Title & Logo
You can add a logo and title to the navbar via themeConfig.navbar
. Logo can be placed in static folder.
// docusaurus.config.js
module.exports = {
themeConfig: {
navbar: {
title: 'Site Title',
logo: {
alt: 'Site Logo',
src: 'img/logo.svg',
},
}
}
Navbar Links
You can add links to the navbar via themeConfig.navbar.links
:
// docusaurus/config.js
module.exports = {
themeConfig: {
navbar: {
links: [
{
to: 'docs/docusaurus.config.js',
label: 'docusaurus.config.js',
position: 'left',
},
// ... other links
],
}
}
Outbound links automatically get target="_blank" rel="noopener noreferrer"
.
Footer
CodeBlock
Docusaurus uses Prism React Renderer to highlight code blocks.
Theme
By default, we use Palenight as syntax highlighting theme. You can specify a custom theme from the list of available themes, e.g.:
// docusaurus/config.js
module.exports = {
themeConfig: {
prism: {
theme: require('prism-react-renderer/themes/dracula'),
},
}
}
Default language
You can set a default language for code blocks if no language is added after the opening triple backticks (i.e. ```). Note that a valid language name must be passed, e.g.:
// docusaurus/config.js
module.exports = {
themeConfig: {
prism: {
defaultLanguage: 'javascript',
},
}
}