Fixing Issue 305 - broken links because of language

examples/basics/core/Footer.js

@@ -8,6 +8,16 @@
 const React = require('react');
 
 class Footer extends React.Component {
+  docUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    return baseUrl + 'docs/' + (language ? language + '/' : '') + doc;
+  }
+
+  pageUrl(doc, language) {
+    const baseUrl = this.props.config.baseUrl;
+    return baseUrl + (language ? language + '/' : '') + doc;
+  }
+
   render() {
     const currentYear = new Date().getFullYear();
     return (
@@ -25,40 +35,19 @@ class Footer extends React.Component {
           </a>
           <div>
             <h5>Docs</h5>
-            <a
-              href={
-                this.props.config.baseUrl +
-                'docs/' +
-                this.props.language +
-                '/doc1.html'
-              }>
+            <a href={this.docUrl('doc1.html', this.props.language)}>
               Getting Started (or other categories)
             </a>
-            <a
-              href={
-                this.props.config.baseUrl +
-                'docs/' +
-                this.props.language +
-                '/doc2.html'
-              }>
+            <a href={this.docUrl('doc2.html', this.props.language)}>
               Guides (or other categories)
             </a>
-            <a
-              href={
-                this.props.config.baseUrl +
-                'docs/' +
-                this.props.language +
-                '/doc3.html'
-              }>
+            <a href={this.docUrl('doc3.html', this.props.language)}>
               API Reference (or other categories)
             </a>
           </div>
           <div>
             <h5>Community</h5>
-            <a
-              href={
-                this.props.config.baseUrl + this.props.language + '/users.html'
-              }>
+            <a href={this.pageUrl('users.html', this.props.language)}>
               User Showcase
             </a>
             <a

examples/basics/pages/en/index.js

@@ -19,11 +19,11 @@ function imgUrl(img) {
 }
 
 function docUrl(doc, language) {
-  return siteConfig.baseUrl + 'docs/' + language + '/' + doc;
+  return siteConfig.baseUrl + 'docs/' + (language ? language + '/' : '') + doc;
 }
 
 function pageUrl(page, language) {
-  return siteConfig.baseUrl + language + '/' + page;
+  return siteConfig.baseUrl + (language ? language + '/' : '') + page;
 }
 
 class Button extends React.Component {
@@ -73,7 +73,7 @@ const PromoSection = props => (
 
 class HomeSplash extends React.Component {
   render() {
-    let language = this.props.language || 'en';
+    let language = this.props.language || '';
     return (
       <SplashContainer>
         <Logo img_src={imgUrl('docusaurus.svg')} />

lib/core/nav/HeaderNav.js

@@ -11,43 +11,36 @@ const React = require('react');
 const fs = require('fs');
 const siteConfig = require(CWD + '/siteConfig.js');
 const translation = require('../../server/translation.js');
+const env = require('../../server/env.js');
 
 const translate = require('../../server/translate.js').translate;
 const setLanguage = require('../../server/translate.js').setLanguage;
 
-const ENABLE_TRANSLATION = fs.existsSync(CWD + '/languages.js');
-const ENABLE_VERSIONING = fs.existsSync(CWD + '/versions.json');
-let versions;
-if (ENABLE_VERSIONING) {
-  versions = require(CWD + '/versions.json');
-}
 const readMetadata = require('../../server/readMetadata.js');
 readMetadata.generateMetadataDocs();
 const Metadata = require('../metadata.js');
 
 // language dropdown nav item for when translations are enabled
 class LanguageDropDown extends React.Component {
   render() {
-    const enabledLanguages = [];
+    if (!env.translation.enabled) {
+      return null;
+    }
+
     let currentLanguage = 'English';
     setLanguage(this.props.language);
     let helpTranslateString = translate(
       'Help Translate|recruit community translators for your project'
     );
     // add all enabled languages to dropdown
-    translation['languages'].map(lang => {
-      if (lang.tag == this.props.language) {
-        currentLanguage = lang.name;
-      }
-      if (lang.tag == this.props.language) {
-        return;
-      }
-      enabledLanguages.push(
+    const enabledLanguages = env.translation
+      .enabledLanguages()
+      .filter(lang => lang !== this.props.language)
+      .map(lang => (
         <li key={lang.tag}>
           <a href={siteConfig.baseUrl + lang.tag}>{lang.name}</a>
         </li>
-      );
-    });
+      ));
     // if no languages are enabled besides English, return null
     if (enabledLanguages.length < 1) {
       return null;
@@ -126,17 +119,14 @@ class HeaderNav extends React.Component {
       );
     } else if (link.doc) {
       // set link to document with current page's language/version
-      let id;
-      if (!ENABLE_VERSIONING || this.props.version === 'next') {
-        id = this.props.language + '-' + link.doc;
-      } else {
-        id =
-          this.props.language +
-          '-version-' +
-          (this.props.version || versions[0]) +
-          '-' +
-          link.doc;
-      }
+      const langPart = env.translation.enabled ? this.props.language + '-' : '';
+      const versionPart =
+        env.translation.enabled && this.props.version !== 'next'
+          ? '-version-' +
+            (this.props.version || env.versioning.latestVersion) +
+            '-'
+          : '';
+      const id = langPart + versionPart + link.doc;
       if (!Metadata[id]) {
         if (id != link.doc) {
           throw new Error(
@@ -153,9 +143,13 @@ class HeaderNav extends React.Component {
       href = this.props.config.baseUrl + Metadata[id].permalink;
     } else if (link.page) {
       // set link to page with current page's language if appropriate
+      const language = this.props.language || '';
       if (fs.existsSync(CWD + '/pages/en/' + link.page + '.js')) {
         href =
-          siteConfig.baseUrl + this.props.language + '/' + link.page + '.html';
+          siteConfig.baseUrl +
+          (language ? language + '/' : '') +
+          link.page +
+          '.html';
       } else {
         href = siteConfig.baseUrl + link.page + '.html';
       }
@@ -180,7 +174,7 @@ class HeaderNav extends React.Component {
   render() {
     const versionsLink =
       this.props.baseUrl +
-      (ENABLE_TRANSLATION
+      (env.translation.enabled
         ? this.props.language + '/versions.html'
         : 'versions.html');
     return (
@@ -198,9 +192,9 @@ class HeaderNav extends React.Component {
                 <h2 className="headerTitle">{this.props.title}</h2>
               )}
             </a>
-            {ENABLE_VERSIONING && (
+            {env.versioning.enabled && (
               <a href={versionsLink}>
-                <h3>{this.props.version || versions[0]}</h3>
+                <h3>{this.props.version || env.versioning.latestVersion}</h3>
               </a>
             )}
             {this.renderResponsiveNav()}

lib/server/env.js

@@ -0,0 +1,68 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const CWD = process.cwd();
+const fs = require('fs-extra');
+const path = require('path');
+
+const join = path.join;
+
+const languages_js = join(CWD, 'lanauages.js');
+const translation_js = join(CWD, 'translation.js');
+const versions_json = join(CWD, 'versions.json');
+
+class Translation {
+  constructor() {
+    this.enabled = false;
+    this.languages = [
+      {
+        enabled: true,
+        name: 'English',
+        tag: 'en',
+      },
+    ];
+
+    this._load();
+  }
+
+  enabledLanguages() {
+    return this.languages.filter(lang => lang.enabled);
+  }
+
+  _load() {
+    if (fs.existsSync(languages_js)) {
+      this.enabled = true;
+      this.languages = require(language_js);
+      this.translation = require(translation_js);
+    }
+  }
+}
+
+class Versioning {
+  constructor() {
+    this.enabled = false;
+    this.latestVersion = null;
+    this.versions = [];
+
+    this._load();
+  }
+
+  _load() {
+    if (fs.existsSync(versions_json)) {
+      this.enabled = true;
+      this.versions = JSON.parse(fs.readFileSync(versions_json, 'utf8'));
+      this.latestVersion = this.versions[0];
+    }
+  }
+}
+
+const env = {
+  translation: new Translation(),
+  versioning: new Versioning(),
+};
+
+module.exports = env;

lib/server/generate.js

@@ -20,30 +20,15 @@ function execute() {
   const glob = require('glob');
   const chalk = require('chalk');
   const Site = require('../core/Site.js');
+  const env = require('./env.js');
   const siteConfig = require(CWD + '/siteConfig.js');
   const translate = require('./translate.js');
-  const versionFallback = require('./versionFallback.js');
 
   const feed = require('./feed.js');
   const sitemap = require('./sitemap.js');
 
   const join = path.join;
 
-  const ENABLE_TRANSLATION = fs.existsSync(join(CWD, 'languages.js'));
-  const ENABLE_VERSIONING = fs.existsSync(join(CWD, 'versions.json'));
-
-  let languages;
-  if (ENABLE_TRANSLATION) {
-    languages = require(CWD + '/languages.js');
-  } else {
-    languages = [
-      {
-        enabled: true,
-        name: 'English',
-        tag: 'en',
-      },
-    ];
-  }
   // create the folder path for a file if it does not exist, then write the file
   function writeFileAndCreateFolder(file, content) {
     mkdirp.sync(file.replace(new RegExp('/[^/]*$'), ''));
@@ -87,10 +72,9 @@ function execute() {
   console.log('generate.js triggered...');
 
   // array of tags of enabled languages
-  const enabledLanguages = [];
-  languages.filter(lang => lang.enabled).map(lang => {
-    enabledLanguages.push(lang.tag);
-  });
+  const enabledLanguages = env.translation
+    .enabledLanguages()
+    .map(lang => lang.tag);
 
   readMetadata.generateMetadataDocs();
   const Metadata = require('../core/metadata.js');
@@ -134,7 +118,7 @@ function execute() {
     // determine what file to use according to its id
     let file;
     if (metadata.original_id) {
-      if (ENABLE_TRANSLATION && metadata.language !== 'en') {
+      if (env.translation.enabled && metadata.language !== 'en') {
         file = join(CWD, 'translated_docs', metadata.language, metadata.source);
       } else {
         file = join(CWD, 'versioned_docs', metadata.source);
@@ -161,12 +145,7 @@ function execute() {
       rawContent = insertTableOfContents(rawContent);
     }
 
-    let latestVersion;
-    if (ENABLE_VERSIONING) {
-      latestVersion = JSON.parse(
-        fs.readFileSync(join(CWD, 'versions.json'), 'utf8')
-      )[0];
-    }
+    let latestVersion = env.versioning.latestVersion;
 
     // replace any links to markdown files to their website html links
     Object.keys(mdToHtml).forEach(function(key, index) {
@@ -207,7 +186,10 @@ function execute() {
     writeFileAndCreateFolder(targetFile, str);
 
     // generate english page redirects when languages are enabled
-    if (ENABLE_TRANSLATION && metadata.permalink.indexOf('docs/en') !== -1) {
+    if (
+      env.translation.enabled &&
+      metadata.permalink.indexOf('docs/en') !== -1
+    ) {
       const redirectComp = (
         <Redirect
           metadata={metadata}
@@ -443,21 +425,25 @@ function execute() {
             str
           );
         }
+
+        // write to base level
+        let language = '';
+        const str = renderToStaticMarkup(
+          <Site language={language} config={siteConfig}>
+            <ReactComp language={language} />
+          </Site>
+        );
+        writeFileAndCreateFolder(targetFile.replace('/en/', '/'), str);
       } else {
         // allow for rendering of other files not in pages/en folder
-        let language = 'en';
-        for (let i = 0; i < langParts.length; i++) {
-          if (enabledLanguages.indexOf(langParts[i]) !== -1) {
-            language = langParts[i];
-          }
-        }
+        let language = '';
         translate.setLanguage(language);
         const str = renderToStaticMarkup(
           <Site language={language} config={siteConfig}>
             <ReactComp language={language} />
           </Site>
         );
-        writeFileAndCreateFolder(targetFile, str);
+        writeFileAndCreateFolder(targetFile.replace('/en/', '/'), str);
       }
       fs.removeSync(tempFile);
     } else if (!fs.lstatSync(file).isDirectory()) {
@@ -469,15 +455,6 @@ function execute() {
     }
   });
 
-  // copy html files in 'en' to base level as well
-  files = glob.sync(join(buildDir, 'en', '**'));
-  files.forEach(file => {
-    let targetFile = file.replace(join(buildDir, 'en'), join(buildDir));
-    if (file.match(/\.html$/)) {
-      fs.copySync(file, targetFile);
-    }
-  });
-
   // Generate CNAME file if a custom domain is specified in siteConfig
   if (siteConfig.cname) {
     let targetFile = join(buildDir, 'CNAME');