3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-25 14:07:50 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add optional sidebar_title docs front matter field for sidebar titles distinct from document article titles

Browse source
This commit is contained in:
Frank Li 2017-07-17 10:57:08 -07:00
parent 523d824651
commit eccbc178e5
3 changed files with 20 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

1
examples/example-docs/en/doc1.md
View file

@ -1,6 +1,7 @@
--- ---
id: doc1 id: doc1
title: Docusaurus title: Docusaurus
sidebar_title: Docusaurus Guide
layout: docs layout: docs
category: Docusaurus category: Docusaurus
permalink: docs/en/doc1.html permalink: docs/en/doc1.html

20
lib/core/nav/SideNav.js
View file

@ -69,12 +69,20 @@ class SideNav extends React.Component {
return categoryString; return categoryString;
} }
getLocalizedString(metadata) { getLocalizedString(metadata) {
let localizedString = translation[this.props.language] let localizedString;
? translation[this.props.language]["localized-strings"][ if (metadata.sidebar_title) {
metadata.localized_id localizedString = translation[this.props.language]
] || metadata.title ? translation[this.props.language]["localized-strings"][
: metadata.title; metadata.sidebar_title
] || metadata.sidebar_title
: metadata.sidebar_title;
} else {
localizedString = translation[this.props.language]
? translation[this.props.language]["localized-strings"][
metadata.localized_id
] || metadata.title
: metadata.title;
}
return localizedString; return localizedString;
} }
getLink(metadata) { getLink(metadata) {

6
lib/write-translations.js
View file

@ -47,6 +47,11 @@ function execute() {
translations["localized-strings"][metadata.id] = metadata.title; translations["localized-strings"][metadata.id] = metadata.title;
translations["localized-strings"][metadata.category] = metadata.category; translations["localized-strings"][metadata.category] = metadata.category;
if (metadata.sidebar_title) {
translations["localized-strings"][metadata.sidebar_title] =
metadata.sidebar_title;
}
} }
}); });
/* look through header links for text to translate */ /* look through header links for text to translate */
@ -89,7 +94,6 @@ function execute() {
}); });
} }
}); });
writeFileAndCreateFolder(CWD + "/i18n/en.json", JSON.stringify(translations)); writeFileAndCreateFolder(CWD + "/i18n/en.json", JSON.stringify(translations));
} }