3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 15:29:32 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(v2): allow prepending of baseUrl to href in navbar and footer (#2746)

Browse source
This commit is contained in:
Yangshun Tay 2020-05-14 11:47:28 +08:00 • committed by GitHub
parent dd1ad5d943
commit be7367b2f8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

18
website/docs/theme-classic.md
View file

@ -132,13 +132,23 @@ module.exports = {
navbar: {
links: [
{
// Client-side routing, used for navigating within the website.
// The baseUrl will be automatically prepended to this value.
to: 'docs/introduction',
// A full-page navigation, used for navigating outside of the website.
// You should only use either `to` or `href`.
href: 'https://www.facebook.com',
// Prepends the baseUrl to href values.
prependBaseUrlToHref: true,
// The string to be shown.
label: 'Introduction',
// Left or right side of the navbar.
position: 'left', // or 'right'
// To apply the active class styling on all
// routes starting with this path.
activeBasePath: 'docs',
className: '', // Custom CSS class (for styling any item)
// Custom CSS class (for styling any item).
className: '',
},
// ... other links
],
@ -148,7 +158,7 @@ module.exports = {
};
```
Outbound links automatically get `target="_blank" rel="noopener noreferrer"` attributes.
Outbound (external) links automatically get `target="_blank" rel="noopener noreferrer"` attributes.
### Navbar Dropdown
@ -200,7 +210,9 @@ module.exports = {
## Footer
## `CodeBlock`
TODO.
## CodeBlock
Docusaurus uses [Prism React Renderer](https://github.com/FormidableLabs/prism-react-renderer) to highlight code blocks.