diff --git a/docs/api-site-config.md b/docs/api-site-config.md index ad5c3ca361..1371271ce9 100644 --- a/docs/api-site-config.md +++ b/docs/api-site-config.md @@ -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, diff --git a/lib/core/nav/HeaderNav.js b/lib/core/nav/HeaderNav.js index 7b9ed64c50..d9d8a1cab9 100644 --- a/lib/core/nav/HeaderNav.js +++ b/lib/core/nav/HeaderNav.js @@ -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 { {env.versioning.enabled && ( -

{this.props.version || env.versioning.latestVersion}

+

{this.props.version || env.versioning.defaultVersion}

)} {this.renderResponsiveNav()} diff --git a/lib/server/env.js b/lib/server/env.js index 6b4504322b..ea0274257b 100644 --- a/lib/server/env.js +++ b/lib/server/env.js @@ -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) } diff --git a/lib/server/generate.js b/lib/server/generate.js index 0f5c4c84ef..31dc1c034e 100644 --- a/lib/server/generate.js +++ b/lib/server/generate.js @@ -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 + '/' : '/' ); diff --git a/lib/server/server.js b/lib/server/server.js index b14033e208..4f3a64f5ad 100644 --- a/lib/server/server.js +++ b/lib/server/server.js @@ -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 + '/' : '/' );