3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 10:17:55 +02:00
Code Issues Projects Releases Packages Wiki Activity

Rename latestVersion to defaultVersion (#639)

Browse source 
* Rename lastVersion to defaultVersion

* Added defaultVersionShown to site-config doc

* Remove defaultVersionShown from siteConfig

* Update api-site-config.md
This commit is contained in:
Erin Teo 2018-05-05 17:24:39 -07:00 • committed by Yangshun Tay
parent dbc597bfd7
commit 5771549e75
5 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/api-site-config.md
View file

@ -84,6 +84,9 @@ customDocsPath: 'docs/site'
```js
customDocsPath: 'website-docs'
```
`defaultVersionShown` - The default version for the site to be shown. If this is not set, the latest version will be shown.
`disableHeaderTitle` - An option to disable showing the title in the header next to the header icon. Exclude this field to keep the header as normal, otherwise set to `true`.
`disableTitleTagline` - An option to disable showing the tagline in the title of main pages. Exclude this field to keep page titles as `Title • Tagline`. Set to `true` to make page titles just `Title`.
@ -181,6 +184,7 @@ const siteConfig = {
// For github.io type URLS, you would combine the url and baseUrl like:
// url: 'https://reasonml.github.io',
// baseUrl: '/reason-react/',
defaultVersionShown: '1.0.0',
organizationName: 'facebook',
projectName: 'docusaurus',
noIndex: false,

4
lib/core/nav/HeaderNav.js
View file

@ -144,7 +144,7 @@ class HeaderNav extends React.Component {
const versionPart =
env.versioning.enabled && this.props.version !== 'next'
? 'version-' +
(this.props.version || env.versioning.latestVersion) +
(this.props.version || env.versioning.defaultVersion) +
'-'
: '';
const id = langPart + versionPart + link.doc;
@ -243,7 +243,7 @@ class HeaderNav extends React.Component {
</a>
{env.versioning.enabled && (
<a href={versionsLink}>
<h3>{this.props.version || env.versioning.latestVersion}</h3>
<h3>{this.props.version || env.versioning.defaultVersion}</h3>
</a>
)}
{this.renderResponsiveNav()}

4
lib/server/env.js
View file

@ -44,7 +44,7 @@ class Translation {
class Versioning {
constructor() {
this.enabled = false;
this.latestVersion = null;
this.defaultVersion = null;
this.versions = [];
this._load();
@ -54,7 +54,7 @@ class Versioning {
if (fs.existsSync(versions_json)) {
this.enabled = true;
this.versions = JSON.parse(fs.readFileSync(versions_json, 'utf8'));
this.latestVersion = siteConfig.defaultVersionShown
this.defaultVersion = siteConfig.defaultVersionShown
? siteConfig.defaultVersionShown
: this.versions[0]; // otherwise show the latest version (other than next/master)
}

4
lib/server/generate.js
View file

@ -143,7 +143,7 @@ async function execute() {
rawContent = insertTableOfContents(rawContent);
}
let latestVersion = env.versioning.latestVersion;
let defaultVersion = env.versioning.defaultVersion;
// replace any links to markdown files to their website html links
Object.keys(mdToHtml).forEach(function(key, index) {
@ -151,7 +151,7 @@ async function execute() {
link = link.replace('/en/', '/' + language + '/');
link = link.replace(
'/VERSION/',
metadata.version && metadata.version !== latestVersion
metadata.version && metadata.version !== defaultVersion
? '/' + metadata.version + '/'
: '/'
);

4
lib/server/server.js
View file

@ -190,7 +190,7 @@ function execute(port) {
rawContent = insertTableOfContents(rawContent);
}
let latestVersion = env.versioning.latestVersion;
let defaultVersion = env.versioning.defaultVersion;
// replace any links to markdown files to their website html links
Object.keys(mdToHtml).forEach(function(key, index) {
@ -198,7 +198,7 @@ function execute(port) {
link = link.replace('/en/', '/' + language + '/');
link = link.replace(
'/VERSION/',
metadata.version && metadata.version !== latestVersion
metadata.version && metadata.version !== defaultVersion
? '/' + metadata.version + '/'
: '/'
);