mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-10 15:47:23 +02:00
ESLintify Part 2 (#841)
* ESLintify Part 2 * Fix * Fix tests * Fix tests * Fix tests
This commit is contained in:
Yangshun Tay
GitHub
parent
4267337fb0
commit
5ac2cee658
42 changed files with 188 additions and 190 deletions
27
.eslintrc.js
27
.eslintrc.js
|
|
@ -12,39 +12,30 @@ module.exports = {
|
|||
parser: 'babel-eslint',
|
||||
extends: ['airbnb', 'prettier'],
|
||||
rules: {
|
||||
// allow console
|
||||
'no-console': OFF,
|
||||
// require radix argument in parseInt
|
||||
'no-console': OFF, // We have console.error, console.warn, etc.
|
||||
radix: ERROR,
|
||||
'class-methods-use-this': OFF,
|
||||
'react/no-multi-comp': OFF,
|
||||
'import/no-extraneous-dependencies': OFF,
|
||||
'react/no-danger': OFF,
|
||||
'no-empty': [ERROR, {allowEmptyCatch: true}],
|
||||
'no-param-reassign': OFF,
|
||||
'no-plusplus': OFF,
|
||||
'import/no-extraneous-dependencies': OFF,
|
||||
'react/jsx-closing-bracket-location': OFF, // Formatting is left to Prettier.
|
||||
'react/jsx-filename-extension': OFF, // Enable in future when migrating.
|
||||
'react/no-danger': OFF, // Need this to inject scripts.
|
||||
'react/no-multi-comp': OFF, // One component per file creates too many files.
|
||||
'react/no-unescaped-entities': [ERROR, {forbid: ['>', '}']}],
|
||||
|
||||
// Existing ESLint errors sorted by frequency, silencing first.
|
||||
'react/button-has-type': OFF, // 1
|
||||
'react/forbid-prop-types': OFF, // 1
|
||||
'react/require-default-props': OFF, // 1
|
||||
'jsx-a11y/anchor-is-valid': OFF, // 9
|
||||
'arrow-body-style': OFF, // 10
|
||||
'react/jsx-curly-brace-presence': OFF, // 11
|
||||
'react/no-unescaped-entities': OFF, // 12
|
||||
'no-param-reassign': OFF, // 12
|
||||
'spaced-comment': OFF, // 14
|
||||
'import/no-unresolved': OFF, // 15
|
||||
'object-shorthand': OFF, // 16
|
||||
'dot-notation': OFF, // 19
|
||||
'react/prefer-stateless-function': OFF, // 22
|
||||
'no-plusplus': OFF, // 23
|
||||
'prefer-arrow-callback': OFF, // 30
|
||||
'react/jsx-filename-extension': OFF, // 31
|
||||
'import/newline-after-import': OFF, // 31
|
||||
'react/jsx-closing-bracket-location': OFF, // 36
|
||||
'func-names': OFF, // 37
|
||||
'import/no-dynamic-require': OFF, // 46
|
||||
'prefer-destructuring': OFF, // 69
|
||||
'prefer-const': OFF, // 71
|
||||
'global-require': OFF, // 85
|
||||
'react/jsx-one-expression-per-line': OFF, // 129
|
||||
'react/prop-types': OFF, // 197
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const GridBlock = CompLibrary.GridBlock;
|
||||
|
||||
|
|
@ -19,7 +20,7 @@ function docUrl(doc, language) {
|
|||
|
||||
class Help extends React.Component {
|
||||
render() {
|
||||
let language = this.props.language || '';
|
||||
const language = this.props.language || '';
|
||||
const supportLinks = [
|
||||
{
|
||||
content: `Learn more using the [documentation on this site.](${docUrl(
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const MarkdownBlock = CompLibrary.MarkdownBlock; /* Used to read markdown */
|
||||
const Container = CompLibrary.Container;
|
||||
const GridBlock = CompLibrary.GridBlock;
|
||||
|
|
@ -73,7 +74,7 @@ const PromoSection = props => (
|
|||
|
||||
class HomeSplash extends React.Component {
|
||||
render() {
|
||||
let language = this.props.language || '';
|
||||
const language = this.props.language || '';
|
||||
return (
|
||||
<SplashContainer>
|
||||
<Logo img_src={imgUrl('docusaurus.svg')} />
|
||||
|
|
@ -179,7 +180,7 @@ const Showcase = props => {
|
|||
|
||||
return (
|
||||
<div className="productShowcaseSection paddingBottom">
|
||||
<h2>Who's Using This?</h2>
|
||||
<h2>Who is Using This?</h2>
|
||||
<p>This project is used by all these people</p>
|
||||
<div className="logos">{showcase}</div>
|
||||
<div className="more-users">
|
||||
|
|
@ -193,7 +194,7 @@ const Showcase = props => {
|
|||
|
||||
class Index extends React.Component {
|
||||
render() {
|
||||
let language = this.props.language || '';
|
||||
const language = this.props.language || '';
|
||||
|
||||
return (
|
||||
<div>
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
|
||||
const siteConfig = require(process.cwd() + '/siteConfig.js');
|
||||
|
|
@ -30,7 +31,7 @@ class Users extends React.Component {
|
|||
<Container padding={['bottom', 'top']}>
|
||||
<div className="showcaseSection">
|
||||
<div className="prose">
|
||||
<h1>Who's Using This?</h1>
|
||||
<h1>Who is Using This?</h1>
|
||||
<p>This project is used by many folks</p>
|
||||
</div>
|
||||
<div className="logos">{showcase}</div>
|
||||
|
|
|
|||
|
|
@ -5,10 +5,10 @@
|
|||
* LICENSE file in the root directory of this source tree.
|
||||
*/
|
||||
|
||||
// See https://docusaurus.io/docs/site-config.html for all the possible
|
||||
// See https://docusaurus.io/docs/site-config for all the possible
|
||||
// site configuration options.
|
||||
|
||||
/* List of projects/orgs using your project for the users page */
|
||||
// List of projects/orgs using your project for the users page.
|
||||
const users = [
|
||||
{
|
||||
caption: 'User1',
|
||||
|
|
@ -21,10 +21,10 @@ const users = [
|
|||
];
|
||||
|
||||
const siteConfig = {
|
||||
title: 'Test Site' /* title for your website */,
|
||||
title: 'Test Site', // Title for your website.
|
||||
tagline: 'A website for testing',
|
||||
url: 'https://your-docusaurus-test-site.com' /* your website url */,
|
||||
baseUrl: '/' /* base url for your project */,
|
||||
url: 'https://your-docusaurus-test-site.com', // Your website URL
|
||||
baseUrl: '/', // Base URL for your project */
|
||||
// For github.io type URLs, you would set the url and baseUrl like:
|
||||
// url: 'https://facebook.github.io',
|
||||
// baseUrl: '/test-site/',
|
||||
|
|
@ -52,14 +52,15 @@ const siteConfig = {
|
|||
footerIcon: 'img/docusaurus.svg',
|
||||
favicon: 'img/favicon.png',
|
||||
|
||||
/* colors for website */
|
||||
/* Colors for website */
|
||||
colors: {
|
||||
primaryColor: '#2E8555',
|
||||
secondaryColor: '#205C3B',
|
||||
},
|
||||
|
||||
/* custom fonts for website */
|
||||
/*fonts: {
|
||||
/* Custom fonts for website */
|
||||
/*
|
||||
fonts: {
|
||||
myFont: [
|
||||
"Times New Roman",
|
||||
"Serif"
|
||||
|
|
@ -68,26 +69,29 @@ const siteConfig = {
|
|||
"-apple-system",
|
||||
"system-ui"
|
||||
]
|
||||
},*/
|
||||
},
|
||||
*/
|
||||
|
||||
// This copyright info is used in /core/Footer.js and blog rss/atom feeds.
|
||||
// This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
|
||||
copyright:
|
||||
'Copyright © ' +
|
||||
new Date().getFullYear() +
|
||||
' Your Name or Your Company Name',
|
||||
|
||||
highlight: {
|
||||
// Highlight.js theme to use for syntax highlighting in code blocks
|
||||
// Highlight.js theme to use for syntax highlighting in code blocks.
|
||||
theme: 'default',
|
||||
},
|
||||
|
||||
// Add custom scripts here that would be placed in <script> tags
|
||||
// Add custom scripts here that would be placed in <script> tags.
|
||||
scripts: ['https://buttons.github.io/buttons.js'],
|
||||
|
||||
/* On page navigation for the current documentation page */
|
||||
// On page navigation for the current documentation page.
|
||||
onPageNav: 'separate',
|
||||
// No .html extensions for paths.
|
||||
cleanUrl: true,
|
||||
|
||||
/* Open Graph and Twitter card images */
|
||||
// Open Graph and Twitter card images.
|
||||
ogImage: 'img/docusaurus.png',
|
||||
twitterImage: 'img/docusaurus.png',
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const GridBlock = CompLibrary.GridBlock;
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
|
@ -34,10 +35,10 @@ function Versions() {
|
|||
<tr>
|
||||
<th>{latestVersion}</th>
|
||||
<td>
|
||||
<a href={''}>Documentation</a>
|
||||
<a href="">Documentation</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href={''}>Release Notes</a>
|
||||
<a href="">Release Notes</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -52,10 +53,10 @@ function Versions() {
|
|||
<tr>
|
||||
<th>master</th>
|
||||
<td>
|
||||
<a href={''}>Documentation</a>
|
||||
<a href="">Documentation</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href={''}>Release Notes</a>
|
||||
<a href="">Release Notes</a>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
@ -70,10 +71,10 @@ function Versions() {
|
|||
<tr>
|
||||
<th>{version}</th>
|
||||
<td>
|
||||
<a href={''}>Documentation</a>
|
||||
<a href="">Documentation</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href={''}>Release Notes</a>
|
||||
<a href="">Release Notes</a>
|
||||
</td>
|
||||
</tr>
|
||||
)
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ const shell = require('shelljs');
|
|||
const CWD = process.cwd();
|
||||
|
||||
const utils = require('../server/utils');
|
||||
|
||||
const siteConfig = require(CWD + '/website/siteConfig.js');
|
||||
const buildDir = CWD + '/website/build';
|
||||
const docsDir = CWD + '/docs';
|
||||
|
|
@ -67,11 +68,9 @@ describe('Build files', () => {
|
|||
});
|
||||
|
||||
test('Generated HTML for each Markdown resource', function() {
|
||||
let metadata = [];
|
||||
outputHTMLFiles.forEach(function(file) {
|
||||
const path = filepath.create(file);
|
||||
metadata.push(path.basename());
|
||||
});
|
||||
const metadata = outputHTMLFiles.map(file =>
|
||||
filepath.create(file).basename()
|
||||
);
|
||||
inputMarkdownFiles.forEach(function(file) {
|
||||
const data = fs.readFileSync(file, 'utf8');
|
||||
const frontmatter = fm(data);
|
||||
|
|
@ -105,11 +104,9 @@ describe('Build files', () => {
|
|||
});
|
||||
|
||||
test('Copied assets from /docs/assets', function() {
|
||||
let metadata = [];
|
||||
outputAssetsFiles.forEach(function(file) {
|
||||
const path = filepath.create(file);
|
||||
metadata.push(path.basename());
|
||||
});
|
||||
const metadata = outputAssetsFiles.map(file =>
|
||||
filepath.create(file).basename()
|
||||
);
|
||||
inputAssetsFiles.forEach(function(file) {
|
||||
const path = filepath.create(file);
|
||||
expect(metadata).toContain(path.basename());
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@ require('babel-register')({
|
|||
// initial check that required files are present
|
||||
const chalk = require('chalk');
|
||||
const fs = require('fs');
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
||||
if (!fs.existsSync(CWD + '/siteConfig.js')) {
|
||||
|
|
@ -33,6 +34,7 @@ if (!fs.existsSync(CWD + '/siteConfig.js')) {
|
|||
|
||||
// generate all static html files
|
||||
const generate = require('./server/generate.js');
|
||||
|
||||
generate()
|
||||
.then(() => {
|
||||
console.log("Site built successfully. Generated files in 'build' folder.");
|
||||
|
|
|
|||
|
|
@ -32,13 +32,13 @@ if (fs.existsSync(CWD + '/package.json')) {
|
|||
if (!packageContent.scripts) {
|
||||
packageContent.scripts = {};
|
||||
}
|
||||
packageContent.scripts['start'] = 'docusaurus-start';
|
||||
packageContent.scripts['build'] = 'docusaurus-build';
|
||||
packageContent.scripts.start = 'docusaurus-start';
|
||||
packageContent.scripts.build = 'docusaurus-build';
|
||||
packageContent.scripts['publish-gh-pages'] = 'docusaurus-publish';
|
||||
packageContent.scripts['examples'] = 'docusaurus-examples';
|
||||
packageContent.scripts.examples = 'docusaurus-examples';
|
||||
packageContent.scripts['write-translations'] =
|
||||
'docusaurus-write-translations';
|
||||
packageContent.scripts['version'] = 'docusaurus-version';
|
||||
packageContent.scripts.version = 'docusaurus-version';
|
||||
packageContent.scripts['rename-version'] = 'docusaurus-rename-version';
|
||||
fs.writeFileSync(
|
||||
CWD + '/package.json',
|
||||
|
|
@ -69,7 +69,7 @@ if (feature === 'translations') {
|
|||
fs.copySync(folder + '/crowdin.yaml', CWD + '/../crowdin.yaml');
|
||||
exampleSiteCreated = true;
|
||||
}
|
||||
let files = glob.sync(folder + '/**/*');
|
||||
const files = glob.sync(folder + '/**/*');
|
||||
files.forEach(file => {
|
||||
if (fs.lstatSync(file).isDirectory()) {
|
||||
return;
|
||||
|
|
@ -97,7 +97,7 @@ if (feature === 'translations') {
|
|||
} else if (feature === 'versions') {
|
||||
// copy files for versions
|
||||
const folder = path.join(__dirname, '..', 'examples', 'versions');
|
||||
let files = glob.sync(folder + '/**/*');
|
||||
const files = glob.sync(folder + '/**/*');
|
||||
files.forEach(file => {
|
||||
if (fs.lstatSync(file).isDirectory()) {
|
||||
return;
|
||||
|
|
@ -171,7 +171,7 @@ if (feature === 'translations') {
|
|||
);
|
||||
|
||||
// copy other files
|
||||
let files = glob.sync(folder + '/**/*');
|
||||
const files = glob.sync(folder + '/**/*');
|
||||
files.forEach(file => {
|
||||
if (fs.lstatSync(file).isDirectory()) {
|
||||
return;
|
||||
|
|
|
|||
|
|
@ -41,20 +41,18 @@ class BlogPageLayout extends React.Component {
|
|||
<Container className="mainContainer postContainer blogContainer">
|
||||
<div className="posts">
|
||||
{MetadataBlog.slice(page * perPage, (page + 1) * perPage).map(
|
||||
post => {
|
||||
return (
|
||||
<BlogPost
|
||||
post={post}
|
||||
content={post.content}
|
||||
truncate
|
||||
key={
|
||||
utils.getPath(post.path, this.props.config.cleanUrl) +
|
||||
post.title
|
||||
}
|
||||
config={this.props.config}
|
||||
/>
|
||||
);
|
||||
}
|
||||
post => (
|
||||
<BlogPost
|
||||
post={post}
|
||||
content={post.content}
|
||||
truncate
|
||||
key={
|
||||
utils.getPath(post.path, this.props.config.cleanUrl) +
|
||||
post.title
|
||||
}
|
||||
config={this.props.config}
|
||||
/>
|
||||
)
|
||||
)}
|
||||
<div className="docs-prevnext">
|
||||
{page > 0 && (
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ class BlogPostLayout extends React.Component {
|
|||
const hasOnPageNav = this.props.config.onPageNav === 'separate';
|
||||
const post = this.props.metadata;
|
||||
post.path = utils.getPath(post.path, this.props.config.cleanUrl);
|
||||
let blogSidebarTitleConfig = this.props.config.blogSidebarTitle || {};
|
||||
const blogSidebarTitleConfig = this.props.config.blogSidebarTitle || {};
|
||||
return (
|
||||
<Site
|
||||
className={classNames('sideNavVisible', {
|
||||
|
|
@ -111,13 +111,13 @@ class BlogPostLayout extends React.Component {
|
|||
})}
|
||||
url={'blog/' + post.path}
|
||||
title={this.props.metadata.title}
|
||||
language={'en'}
|
||||
language="en"
|
||||
description={this.getDescription()}
|
||||
config={this.props.config}
|
||||
metadata={{blog: true}}>
|
||||
<div className="docMainWrapper wrapper">
|
||||
<BlogSidebar
|
||||
language={'en'}
|
||||
language="en"
|
||||
current={post}
|
||||
config={this.props.config}
|
||||
/>
|
||||
|
|
@ -126,7 +126,7 @@ class BlogPostLayout extends React.Component {
|
|||
<BlogPost
|
||||
post={post}
|
||||
content={this.props.children}
|
||||
language={'en'}
|
||||
language="en"
|
||||
config={this.props.config}
|
||||
/>
|
||||
{this.renderSocialButtons()}
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ const MetadataBlog = require('./MetadataBlog.js');
|
|||
class BlogSidebar extends React.Component {
|
||||
render() {
|
||||
let blogSidebarCount = 5;
|
||||
let blogSidebarTitleConfig = this.props.config.blogSidebarTitle || {};
|
||||
const blogSidebarTitleConfig = this.props.config.blogSidebarTitle || {};
|
||||
let blogSidebarTitle = blogSidebarTitleConfig.default || 'Recent Posts';
|
||||
if (this.props.config.blogSidebarCount) {
|
||||
if (this.props.config.blogSidebarCount === 'ALL') {
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ const GridBlock = require('./GridBlock.js');
|
|||
|
||||
// A collection of components to provide to users
|
||||
module.exports = {
|
||||
MarkdownBlock: MarkdownBlock,
|
||||
Container: Container,
|
||||
GridBlock: GridBlock,
|
||||
MarkdownBlock,
|
||||
Container,
|
||||
GridBlock,
|
||||
};
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ class DocsLayout extends React.Component {
|
|||
][metadata.previous_id] ||
|
||||
translation[this.props.metadata.language][
|
||||
'localized-strings'
|
||||
]['previous'] ||
|
||||
].previous ||
|
||||
'Previous'
|
||||
: metadata.previous_title || 'Previous'}
|
||||
</a>
|
||||
|
|
@ -103,7 +103,7 @@ class DocsLayout extends React.Component {
|
|||
][metadata.next_id] ||
|
||||
translation[this.props.metadata.language][
|
||||
'localized-strings'
|
||||
]['next'] ||
|
||||
].next ||
|
||||
'Next'
|
||||
: metadata.next_title || 'Next'}{' '}
|
||||
→
|
||||
|
|
|
|||
|
|
@ -12,8 +12,8 @@ const readCategories = require('../server/readCategories.js');
|
|||
|
||||
class DocsSidebar extends React.Component {
|
||||
render() {
|
||||
let sidebar = this.props.metadata.sidebar;
|
||||
let docsCategories = readCategories(sidebar);
|
||||
const sidebar = this.props.metadata.sidebar;
|
||||
const docsCategories = readCategories(sidebar);
|
||||
const categoryName = docsCategories[this.props.metadata.language][0].name;
|
||||
if (!categoryName) {
|
||||
return null;
|
||||
|
|
|
|||
|
|
@ -13,14 +13,14 @@ class Head extends React.Component {
|
|||
const links = this.props.config.headerLinks;
|
||||
const hasBlog = links.some(link => link.blog);
|
||||
|
||||
let highlight = {
|
||||
const highlight = {
|
||||
version: '9.12.0',
|
||||
theme: 'default',
|
||||
...this.props.config.highlight,
|
||||
};
|
||||
|
||||
// Use user-provided themeUrl if it exists, else construct one from version and theme.
|
||||
let highlightThemeURL = highlight.themeUrl
|
||||
const highlightThemeURL = highlight.themeUrl
|
||||
? highlight.themeUrl
|
||||
: `//cdnjs.cloudflare.com/ajax/libs/highlight.js/${
|
||||
highlight.version
|
||||
|
|
@ -143,17 +143,13 @@ class Head extends React.Component {
|
|||
))}
|
||||
|
||||
{this.props.config.scrollToTop && (
|
||||
<script
|
||||
src={
|
||||
'https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js'
|
||||
}
|
||||
/>
|
||||
<script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js" />
|
||||
)}
|
||||
{this.props.config.scrollToTop && (
|
||||
<script
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: `
|
||||
document.addEventListener("DOMContentLoaded", function(){
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
addBackToTop(
|
||||
${JSON.stringify(
|
||||
Object.assign(
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ const fs = require('fs');
|
|||
|
||||
const HeaderNav = require('./nav/HeaderNav.js');
|
||||
const Head = require('./Head.js');
|
||||
|
||||
const Footer = require(process.cwd() + '/core/Footer.js');
|
||||
const translation = require('../server/translation.js');
|
||||
const constants = require('./constants');
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ const CWD = process.cwd();
|
|||
const React = require('react');
|
||||
const fs = require('fs');
|
||||
const classNames = require('classnames');
|
||||
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
const translation = require('../../server/translation.js');
|
||||
const env = require('../../server/env.js');
|
||||
|
|
@ -18,16 +19,18 @@ const translate = require('../../server/translate.js').translate;
|
|||
const setLanguage = require('../../server/translate.js').setLanguage;
|
||||
|
||||
const readMetadata = require('../../server/readMetadata.js');
|
||||
|
||||
readMetadata.generateMetadataDocs();
|
||||
const Metadata = require('../metadata.js');
|
||||
const utils = require('../utils.js');
|
||||
|
||||
const extension = siteConfig.cleanUrl ? '' : '.html';
|
||||
|
||||
// language dropdown nav item for when translations are enabled
|
||||
class LanguageDropDown extends React.Component {
|
||||
render() {
|
||||
setLanguage(this.props.language || 'en');
|
||||
let helpTranslateString = translate(
|
||||
const helpTranslateString = translate(
|
||||
'Help Translate|recruit community translators for your project'
|
||||
);
|
||||
// add all enabled languages to dropdown
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ const utils = require('../utils.js');
|
|||
class SideNav extends React.Component {
|
||||
// return appropriately translated category string
|
||||
getLocalizedCategoryString(category) {
|
||||
let categoryString = translation[this.props.language]
|
||||
const categoryString = translation[this.props.language]
|
||||
? translation[this.props.language]['localized-strings'][category] ||
|
||||
category
|
||||
: category;
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ class MarkdownRenderer {
|
|||
// Highlight.js expects hljs css classes on the code element.
|
||||
// This results in <pre><code class="hljs css languages-jsx">
|
||||
langPrefix: 'hljs css languages-',
|
||||
highlight: function(str, lang) {
|
||||
highlight(str, lang) {
|
||||
lang =
|
||||
lang || (siteConfig.highlight && siteConfig.highlight.defaultLang);
|
||||
if (lang) {
|
||||
|
|
@ -90,6 +90,4 @@ class MarkdownRenderer {
|
|||
|
||||
const renderMarkdown = new MarkdownRenderer();
|
||||
|
||||
module.exports = source => {
|
||||
return renderMarkdown.toHtml(source);
|
||||
};
|
||||
module.exports = source => renderMarkdown.toHtml(source);
|
||||
|
|
|
|||
|
|
@ -42,9 +42,9 @@ module.exports = (string, context = {}) => {
|
|||
// Handle uppercase characters
|
||||
.toLowerCase()
|
||||
// Handle accentuated characters
|
||||
.replace(new RegExp('[' + accents + ']', 'g'), c => {
|
||||
return without.charAt(accents.indexOf(c));
|
||||
})
|
||||
.replace(new RegExp('[' + accents + ']', 'g'), c =>
|
||||
without.charAt(accents.indexOf(c))
|
||||
)
|
||||
// Replace `.`, `(` and `?` with blank string like Github does
|
||||
.replace(/\.|\(|\?/g, '')
|
||||
// Dash special characters
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ require('babel-register')({
|
|||
// initial check that required files are present
|
||||
const chalk = require('chalk');
|
||||
const fs = require('fs');
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
||||
if (!fs.existsSync(CWD + '/siteConfig.js')) {
|
||||
|
|
@ -28,4 +29,5 @@ if (!fs.existsSync(CWD + '/siteConfig.js')) {
|
|||
|
||||
// generate rss feed
|
||||
const feed = require('./server/feed.js');
|
||||
|
||||
console.log(feed());
|
||||
|
|
|
|||
|
|
@ -112,9 +112,9 @@ if (fs.existsSync(CWD + '/versioned_docs/version-' + currentVersion)) {
|
|||
|
||||
// if sidebar file exists for this version, rename sidebar file and rewrite
|
||||
// doc ids in the file
|
||||
let currentSidebarFile =
|
||||
const currentSidebarFile =
|
||||
CWD + '/versioned_sidebars/version-' + currentVersion + '-sidebars.json';
|
||||
let newSidebarFile =
|
||||
const newSidebarFile =
|
||||
CWD + '/versioned_sidebars/version-' + newVersion + '-sidebars.json';
|
||||
if (fs.existsSync(currentSidebarFile)) {
|
||||
fs.renameSync(currentSidebarFile, newSidebarFile);
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ const CWD = process.cwd();
|
|||
const fs = require('fs-extra');
|
||||
const path = require('path');
|
||||
const chalk = require('chalk');
|
||||
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
|
||||
const join = path.join;
|
||||
|
|
|
|||
|
|
@ -6,9 +6,11 @@
|
|||
*/
|
||||
|
||||
const Feed = require('feed');
|
||||
|
||||
const CWD = process.cwd();
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
const readMetadata = require('./readMetadata.js');
|
||||
|
||||
const blogRootURL = siteConfig.url + siteConfig.baseUrl + 'blog';
|
||||
const siteImageURL =
|
||||
siteConfig.url + siteConfig.baseUrl + siteConfig.headerIcon;
|
||||
|
|
|
|||
|
|
@ -158,7 +158,7 @@ async function execute() {
|
|||
rawContent = insertTableOfContents(rawContent);
|
||||
}
|
||||
|
||||
let defaultVersion = env.versioning.defaultVersion;
|
||||
const defaultVersion = env.versioning.defaultVersion;
|
||||
|
||||
// replace any links to markdown files to their website html links
|
||||
Object.keys(mdToHtml).forEach(key => {
|
||||
|
|
@ -250,7 +250,7 @@ async function execute() {
|
|||
.forEach(file => {
|
||||
// Why normalize? In case we are on Windows.
|
||||
// Remember the nuance of glob: https://www.npmjs.com/package/glob#windows
|
||||
let normalizedFile = path.normalize(file);
|
||||
const normalizedFile = path.normalize(file);
|
||||
const extension = path.extname(normalizedFile);
|
||||
if (extension !== '.md' && extension !== '.markdown') {
|
||||
return;
|
||||
|
|
@ -273,7 +273,7 @@ async function execute() {
|
|||
);
|
||||
metadata.id = metadata.title;
|
||||
|
||||
let language = 'en';
|
||||
const language = 'en';
|
||||
const blogPostComp = (
|
||||
<BlogPostLayout
|
||||
metadata={metadata}
|
||||
|
|
@ -284,15 +284,15 @@ async function execute() {
|
|||
);
|
||||
const str = renderToStaticMarkupWithDoctype(blogPostComp);
|
||||
|
||||
let targetFile = join(buildDir, 'blog', filePath);
|
||||
const targetFile = join(buildDir, 'blog', filePath);
|
||||
writeFileAndCreateFolder(targetFile, str);
|
||||
});
|
||||
// create html files for all blog pages (collections of article previews)
|
||||
const BlogPageLayout = require('../core/BlogPageLayout.js');
|
||||
const perPage = 10;
|
||||
for (let page = 0; page < Math.ceil(MetadataBlog.length / perPage); page++) {
|
||||
let language = 'en';
|
||||
const metadata = {page: page, perPage: perPage};
|
||||
const language = 'en';
|
||||
const metadata = {page, perPage};
|
||||
const blogPageComp = (
|
||||
<BlogPageLayout
|
||||
metadata={metadata}
|
||||
|
|
@ -302,7 +302,7 @@ async function execute() {
|
|||
);
|
||||
const str = renderToStaticMarkupWithDoctype(blogPageComp);
|
||||
|
||||
let targetFile = join(
|
||||
const targetFile = join(
|
||||
buildDir,
|
||||
'blog',
|
||||
page > 0 ? 'page' + (page + 1) : '',
|
||||
|
|
@ -389,7 +389,7 @@ async function execute() {
|
|||
files.forEach(file => {
|
||||
// Why normalize? In case we are on Windows.
|
||||
// Remember the nuance of glob: https://www.npmjs.com/package/glob#windows
|
||||
let normalizedFile = path.normalize(file);
|
||||
const normalizedFile = path.normalize(file);
|
||||
// parse css files to replace colors and fonts according to siteConfig
|
||||
if (normalizedFile.match(/\.css$/) && !isSeparateCss(normalizedFile)) {
|
||||
const mainCss = join(buildDir, 'css', 'main.css');
|
||||
|
|
@ -453,7 +453,7 @@ async function execute() {
|
|||
files.forEach(file => {
|
||||
// Why normalize? In case we are on Windows.
|
||||
// Remember the nuance of glob: https://www.npmjs.com/package/glob#windows
|
||||
let normalizedFile = path.normalize(file);
|
||||
const normalizedFile = path.normalize(file);
|
||||
// render .js files to strings
|
||||
if (normalizedFile.match(/\.js$/)) {
|
||||
const pageID = path.basename(normalizedFile, '.js');
|
||||
|
|
@ -511,7 +511,7 @@ async function execute() {
|
|||
}
|
||||
|
||||
// write to base level
|
||||
let language = env.translation.enabled ? 'en' : '';
|
||||
const language = env.translation.enabled ? 'en' : '';
|
||||
translate.setLanguage(language);
|
||||
const str = renderToStaticMarkupWithDoctype(
|
||||
<Site
|
||||
|
|
@ -529,7 +529,7 @@ async function execute() {
|
|||
);
|
||||
} else {
|
||||
// allow for rendering of other files not in pages/en folder
|
||||
let language = env.translation.enabled ? 'en' : '';
|
||||
const language = env.translation.enabled ? 'en' : '';
|
||||
translate.setLanguage(language);
|
||||
const str = renderToStaticMarkupWithDoctype(
|
||||
<Site
|
||||
|
|
@ -564,8 +564,8 @@ async function execute() {
|
|||
writeFileAndCreateFolder(targetFile, str);
|
||||
} else if (!fs.lstatSync(normalizedFile).isDirectory()) {
|
||||
// copy other non .js files
|
||||
let parts = normalizedFile.split('pages');
|
||||
let targetFile = join(buildDir, parts[1]);
|
||||
const parts = normalizedFile.split('pages');
|
||||
const targetFile = join(buildDir, parts[1]);
|
||||
mkdirp.sync(path.dirname(targetFile));
|
||||
fs.copySync(normalizedFile, targetFile);
|
||||
}
|
||||
|
|
@ -573,7 +573,7 @@ async function execute() {
|
|||
|
||||
// Generate CNAME file if a custom domain is specified in siteConfig
|
||||
if (siteConfig.cname) {
|
||||
let targetFile = join(buildDir, 'CNAME');
|
||||
const targetFile = join(buildDir, 'CNAME');
|
||||
fs.writeFileSync(targetFile, siteConfig.cname);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ const glob = require('glob');
|
|||
const metadataUtils = require('./metadataUtils');
|
||||
|
||||
const env = require('./env.js');
|
||||
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
const versionFallback = require('./versionFallback.js');
|
||||
const utils = require('./utils.js');
|
||||
|
|
@ -56,7 +57,7 @@ function readSidebar() {
|
|||
const categories = allSidebars[sidebar];
|
||||
|
||||
let ids = [];
|
||||
let categoryOrder = [];
|
||||
const categoryOrder = [];
|
||||
Object.keys(categories).forEach(category => {
|
||||
ids = ids.concat(categories[category]);
|
||||
for (let i = 0; i < categories[category].length; i++) {
|
||||
|
|
@ -71,9 +72,9 @@ function readSidebar() {
|
|||
if (i > 0) previous = ids[i - 1];
|
||||
if (i < ids.length - 1) next = ids[i + 1];
|
||||
order[id] = {
|
||||
previous: previous,
|
||||
next: next,
|
||||
sidebar: sidebar,
|
||||
previous,
|
||||
next,
|
||||
sidebar,
|
||||
category: categoryOrder[i],
|
||||
};
|
||||
}
|
||||
|
|
@ -156,7 +157,7 @@ function processMetadata(file, refDir) {
|
|||
}
|
||||
}
|
||||
|
||||
return {metadata, rawContent: rawContent};
|
||||
return {metadata, rawContent};
|
||||
}
|
||||
|
||||
// process metadata for all docs and save into core/metadata.js
|
||||
|
|
@ -188,7 +189,7 @@ function generateMetadataDocs() {
|
|||
if (!res) {
|
||||
return;
|
||||
}
|
||||
let metadata = res.metadata;
|
||||
const metadata = res.metadata;
|
||||
metadatas[metadata.id] = metadata;
|
||||
|
||||
// create a default list of documents for each enabled language based on docs in English
|
||||
|
|
@ -196,24 +197,24 @@ function generateMetadataDocs() {
|
|||
enabledLanguages
|
||||
.filter(currentLanguage => currentLanguage !== 'en')
|
||||
.forEach(currentLanguage => {
|
||||
let baseMetadata = Object.assign({}, metadata);
|
||||
baseMetadata['id'] = baseMetadata['id']
|
||||
const baseMetadata = Object.assign({}, metadata);
|
||||
baseMetadata.id = baseMetadata.id
|
||||
.toString()
|
||||
.replace(/^en-/, currentLanguage + '-');
|
||||
if (baseMetadata['permalink'])
|
||||
baseMetadata['permalink'] = baseMetadata['permalink']
|
||||
if (baseMetadata.permalink)
|
||||
baseMetadata.permalink = baseMetadata.permalink
|
||||
.toString()
|
||||
.replace(/^docs\/en\//, 'docs/' + currentLanguage + '/');
|
||||
if (baseMetadata['next'])
|
||||
baseMetadata['next'] = baseMetadata['next']
|
||||
if (baseMetadata.next)
|
||||
baseMetadata.next = baseMetadata.next
|
||||
.toString()
|
||||
.replace(/^en-/, currentLanguage + '-');
|
||||
if (baseMetadata['previous'])
|
||||
baseMetadata['previous'] = baseMetadata['previous']
|
||||
if (baseMetadata.previous)
|
||||
baseMetadata.previous = baseMetadata.previous
|
||||
.toString()
|
||||
.replace(/^en-/, currentLanguage + '-');
|
||||
baseMetadata['language'] = currentLanguage;
|
||||
defaultMetadatas[baseMetadata['id']] = baseMetadata;
|
||||
baseMetadata.language = currentLanguage;
|
||||
defaultMetadatas[baseMetadata.id] = baseMetadata;
|
||||
});
|
||||
Object.assign(metadatas, defaultMetadatas);
|
||||
}
|
||||
|
|
@ -234,7 +235,7 @@ function generateMetadataDocs() {
|
|||
if (!res) {
|
||||
return;
|
||||
}
|
||||
let metadata = res.metadata;
|
||||
const metadata = res.metadata;
|
||||
metadatas[metadata.id] = metadata;
|
||||
}
|
||||
});
|
||||
|
|
@ -305,7 +306,7 @@ function generateMetadataDocs() {
|
|||
function generateMetadataBlog() {
|
||||
const metadatas = [];
|
||||
|
||||
let files = glob.sync(CWD + '/blog/**/*.*');
|
||||
const files = glob.sync(CWD + '/blog/**/*.*');
|
||||
files
|
||||
.sort()
|
||||
.reverse()
|
||||
|
|
@ -336,7 +337,7 @@ function generateMetadataBlog() {
|
|||
metadata.id = metadata.title;
|
||||
|
||||
// Extract, YYYY, MM, DD from the file name
|
||||
let filePathDateArr = path
|
||||
const filePathDateArr = path
|
||||
.basename(file)
|
||||
.toString()
|
||||
.split('-');
|
||||
|
|
|
|||
|
|
@ -71,9 +71,7 @@ function execute(port, options) {
|
|||
}
|
||||
}
|
||||
|
||||
/****************************************************************************/
|
||||
|
||||
let readMetadata = require('./readMetadata.js');
|
||||
const readMetadata = require('./readMetadata.js');
|
||||
let Metadata;
|
||||
let MetadataBlog;
|
||||
let siteConfig;
|
||||
|
|
@ -103,8 +101,6 @@ function execute(port, options) {
|
|||
}
|
||||
}
|
||||
|
||||
/****************************************************************************/
|
||||
|
||||
const TABLE_OF_CONTENTS_TOKEN = '<AUTOGENERATED_TABLE_OF_CONTENTS>';
|
||||
|
||||
const insertTableOfContents = rawContent => {
|
||||
|
|
@ -119,8 +115,6 @@ function execute(port, options) {
|
|||
return rawContent.replace(TABLE_OF_CONTENTS_TOKEN, tableOfContents);
|
||||
};
|
||||
|
||||
/****************************************************************************/
|
||||
|
||||
function isSeparateCss(file) {
|
||||
if (!siteConfig.separateCss) {
|
||||
return false;
|
||||
|
|
@ -181,8 +175,6 @@ function execute(port, options) {
|
|||
);
|
||||
}
|
||||
|
||||
/****************************************************************************/
|
||||
|
||||
reloadMetadata();
|
||||
reloadMetadataBlog();
|
||||
extractTranslations();
|
||||
|
|
@ -192,10 +184,10 @@ function execute(port, options) {
|
|||
|
||||
// handle all requests for document pages
|
||||
app.get(docsRouting(siteConfig.baseUrl), (req, res, next) => {
|
||||
let url = req.path.toString().replace(siteConfig.baseUrl, '');
|
||||
const url = req.path.toString().replace(siteConfig.baseUrl, '');
|
||||
|
||||
// links is a map from a permalink to an id for each document
|
||||
let links = {};
|
||||
const links = {};
|
||||
Object.keys(Metadata).forEach(id => {
|
||||
const metadata = Metadata[id];
|
||||
links[metadata.permalink] = id;
|
||||
|
|
@ -254,7 +246,7 @@ function execute(port, options) {
|
|||
rawContent = insertTableOfContents(rawContent);
|
||||
}
|
||||
|
||||
let defaultVersion = env.versioning.defaultVersion;
|
||||
const defaultVersion = env.versioning.defaultVersion;
|
||||
|
||||
// replace any links to markdown files to their website html links
|
||||
Object.keys(mdToHtml).forEach(key => {
|
||||
|
|
@ -326,7 +318,7 @@ function execute(port, options) {
|
|||
|
||||
app.get(feedRouting(siteConfig.baseUrl), (req, res, next) => {
|
||||
res.set('Content-Type', 'application/rss+xml');
|
||||
let file = req.path
|
||||
const file = req.path
|
||||
.toString()
|
||||
.split('blog/')[1]
|
||||
.toLowerCase();
|
||||
|
|
@ -354,8 +346,8 @@ function execute(port, options) {
|
|||
page < Math.ceil(MetadataBlog.length / perPage);
|
||||
page++
|
||||
) {
|
||||
let language = 'en';
|
||||
const metadata = {page: page, perPage: perPage};
|
||||
const language = 'en';
|
||||
const metadata = {page, perPage};
|
||||
const blogPageComp = (
|
||||
<BlogPageLayout
|
||||
metadata={metadata}
|
||||
|
|
@ -369,7 +361,7 @@ function execute(port, options) {
|
|||
blogPages[pagePath] = str;
|
||||
}
|
||||
|
||||
let parts = req.path.toString().split('blog/');
|
||||
const parts = req.path.toString().split('blog/');
|
||||
// send corresponding blog page if appropriate
|
||||
if (parts[1] === 'index.html') {
|
||||
res.send(blogPages['/index.html']);
|
||||
|
|
@ -412,7 +404,7 @@ function execute(port, options) {
|
|||
);
|
||||
metadata.id = metadata.title;
|
||||
|
||||
let language = 'en';
|
||||
const language = 'en';
|
||||
removeModuleAndChildrenFromCache(join('..', 'core', 'BlogPostLayout.js'));
|
||||
const BlogPostLayout = require(join('..', 'core', 'BlogPostLayout.js'));
|
||||
|
||||
|
|
@ -502,7 +494,7 @@ function execute(port, options) {
|
|||
fs.existsSync((userFile = englishFile))
|
||||
) {
|
||||
// copy into docusaurus so require paths work
|
||||
let userFileParts = userFile.split('pages' + sep);
|
||||
const userFileParts = userFile.split('pages' + sep);
|
||||
let tempFile = join(__dirname, '..', 'pages', userFileParts[1]);
|
||||
tempFile = tempFile.replace(
|
||||
path.basename(file),
|
||||
|
|
@ -546,7 +538,7 @@ function execute(port, options) {
|
|||
);
|
||||
let cssContent = fs.readFileSync(mainCssPath, {encoding: 'utf8'});
|
||||
|
||||
let files = glob.sync(join(CWD, 'static', '**', '*.css'));
|
||||
const files = glob.sync(join(CWD, 'static', '**', '*.css'));
|
||||
|
||||
files.forEach(file => {
|
||||
if (isSeparateCss(file)) {
|
||||
|
|
@ -604,8 +596,8 @@ function execute(port, options) {
|
|||
// "redirect" requests to pages ending with "/" or no extension so that,
|
||||
// for example, request to "blog" returns "blog/index.html" or "blog.html"
|
||||
app.get(noExtRouting(), (req, res, next) => {
|
||||
let slash = req.path.toString().endsWith('/') ? '' : '/';
|
||||
let requestUrl = 'http://localhost:' + port + req.path;
|
||||
const slash = req.path.toString().endsWith('/') ? '' : '/';
|
||||
const requestUrl = 'http://localhost:' + port + req.path;
|
||||
requestFile(requestUrl + slash + 'index.html', res, () => {
|
||||
requestFile(
|
||||
slash === '/'
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const fs = require('fs-extra');
|
||||
|
||||
const glob = require('glob');
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
||||
const sitemap = require('sitemap');
|
||||
|
|
@ -15,24 +16,18 @@ const utils = require('../core/utils');
|
|||
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
|
||||
/****************************************************************************/
|
||||
const readMetadata = require('./readMetadata.js');
|
||||
|
||||
let readMetadata;
|
||||
let Metadata;
|
||||
let MetadataBlog;
|
||||
|
||||
readMetadata = require('./readMetadata.js');
|
||||
readMetadata.generateMetadataDocs();
|
||||
Metadata = require('../core/metadata.js');
|
||||
readMetadata.generateMetadataBlog();
|
||||
MetadataBlog = require('../core/MetadataBlog.js');
|
||||
const Metadata = require('../core/metadata.js');
|
||||
|
||||
/****************************************************************************/
|
||||
readMetadata.generateMetadataBlog();
|
||||
const MetadataBlog = require('../core/MetadataBlog.js');
|
||||
|
||||
module.exports = function(callback) {
|
||||
console.log('sitemap.js triggered...');
|
||||
|
||||
let files = glob.sync(CWD + '/pages/en/**/*.js');
|
||||
const files = glob.sync(CWD + '/pages/en/**/*.js');
|
||||
|
||||
// English-only is the default.
|
||||
let enabledLanguages = [
|
||||
|
|
@ -45,7 +40,7 @@ module.exports = function(callback) {
|
|||
|
||||
// If we have a languages.js file, get all the enabled languages in there
|
||||
if (fs.existsSync(CWD + '/languages.js')) {
|
||||
let languages = require(CWD + '/languages.js');
|
||||
const languages = require(CWD + '/languages.js');
|
||||
enabledLanguages = languages.filter(lang => lang.enabled);
|
||||
}
|
||||
|
||||
|
|
@ -56,7 +51,7 @@ module.exports = function(callback) {
|
|||
? url.replace(/\.js$/, '')
|
||||
: url.replace(/\.js$/, '.html');
|
||||
const links = enabledLanguages.map(lang => {
|
||||
let langUrl = lang.tag + url;
|
||||
const langUrl = lang.tag + url;
|
||||
return {lang: lang.tag, url: langUrl};
|
||||
});
|
||||
return {url, changefreq: 'weekly', priority: 0.5, links};
|
||||
|
|
@ -73,10 +68,10 @@ module.exports = function(callback) {
|
|||
Object.keys(Metadata)
|
||||
.filter(key => Metadata[key].language === 'en')
|
||||
.forEach(key => {
|
||||
let doc = Metadata[key];
|
||||
let docUrl = utils.getPath(doc.permalink, siteConfig.cleanUrl);
|
||||
let links = enabledLanguages.map(lang => {
|
||||
let langUrl = docUrl.replace('docs/en/', `docs/${lang.tag}/`);
|
||||
const doc = Metadata[key];
|
||||
const docUrl = utils.getPath(doc.permalink, siteConfig.cleanUrl);
|
||||
const links = enabledLanguages.map(lang => {
|
||||
const langUrl = docUrl.replace('docs/en/', `docs/${lang.tag}/`);
|
||||
return {lang: lang.tag, url: langUrl};
|
||||
});
|
||||
urls.push({
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ function translate(str) {
|
|||
if (!language || language === '') {
|
||||
// Check English, just in case; otherwise, just return the raw string back
|
||||
if (doesTranslationExist(str, 'en')) {
|
||||
return parseEscapeSequences(translation['en']['pages-strings'][str]);
|
||||
return parseEscapeSequences(translation.en['pages-strings'][str]);
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
|
@ -54,7 +54,7 @@ function translate(str) {
|
|||
"'. Using English version instead."
|
||||
);
|
||||
|
||||
return parseEscapeSequences(translation['en']['pages-strings'][str]);
|
||||
return parseEscapeSequences(translation.en['pages-strings'][str]);
|
||||
}
|
||||
throw new Error(
|
||||
"Text that you've identified for translation ('" +
|
||||
|
|
@ -66,6 +66,6 @@ function translate(str) {
|
|||
}
|
||||
|
||||
module.exports = {
|
||||
setLanguage: setLanguage,
|
||||
translate: translate,
|
||||
setLanguage,
|
||||
translate,
|
||||
};
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ function getSubDir(file, refDir) {
|
|||
// (file: '/website/translated_docs/ko/projectA/test.md', refDir: 'website/translated_docs')
|
||||
// returns 'ko'
|
||||
function getLanguage(file, refDir) {
|
||||
let regexSubFolder = new RegExp(
|
||||
const regexSubFolder = new RegExp(
|
||||
'/' + escapeStringRegexp(path.basename(refDir)) + '/(.*)/.*/'
|
||||
);
|
||||
const match = regexSubFolder.exec(file);
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ const metadataUtils = require('./metadataUtils');
|
|||
|
||||
const env = require('./env.js');
|
||||
const utils = require('./utils.js');
|
||||
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
|
||||
const ENABLE_TRANSLATION = fs.existsSync(CWD + '/languages.js');
|
||||
|
|
@ -46,7 +47,7 @@ const available = {};
|
|||
// versionFiles is used to keep track of what file to use with a
|
||||
// given version/id of a document
|
||||
const versionFiles = {};
|
||||
let files = glob.sync(versionFolder + '**');
|
||||
const files = glob.sync(versionFolder + '**');
|
||||
files.forEach(file => {
|
||||
const ext = path.extname(file);
|
||||
if (ext !== '.md' && ext !== '.markdown') {
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ const versionFolder = CWD + '/versioned_docs/version-' + version;
|
|||
mkdirp.sync(versionFolder);
|
||||
|
||||
// copy necessary files to new version, changing some of its metadata to reflect the versioning
|
||||
let files = glob.sync(CWD + '/../' + readMetadata.getDocsPath() + '/**');
|
||||
const files = glob.sync(CWD + '/../' + readMetadata.getDocsPath() + '/**');
|
||||
files.forEach(file => {
|
||||
const ext = path.extname(file);
|
||||
if (ext !== '.md' && ext !== '.markdown') {
|
||||
|
|
@ -88,12 +88,12 @@ files.forEach(file => {
|
|||
}
|
||||
|
||||
const res = metadataUtils.extractMetadata(fs.readFileSync(file, 'utf8'));
|
||||
let metadata = res.metadata;
|
||||
const metadata = res.metadata;
|
||||
// Don't version any docs without any metadata whatsoever.
|
||||
if (Object.keys(metadata).length === 0) {
|
||||
return;
|
||||
}
|
||||
let rawContent = res.rawContent;
|
||||
const rawContent = res.rawContent;
|
||||
if (!metadata.id) {
|
||||
metadata.id = path.basename(file, path.extname(file));
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ const mkdirp = require('mkdirp');
|
|||
const nodePath = require('path');
|
||||
|
||||
const readMetadata = require('./server/readMetadata.js');
|
||||
|
||||
const CWD = process.cwd();
|
||||
const siteConfig = require(CWD + '/siteConfig.js');
|
||||
const sidebars = require(CWD + '/sidebars.json');
|
||||
|
|
@ -47,7 +48,7 @@ function writeFileAndCreateFolder(file, content) {
|
|||
}
|
||||
|
||||
function execute() {
|
||||
let translations = {
|
||||
const translations = {
|
||||
'localized-strings': {
|
||||
next: 'Next',
|
||||
previous: 'Previous',
|
||||
|
|
|
|||
|
|
@ -23,7 +23,8 @@
|
|||
"precommit": "lint-staged",
|
||||
"prettier": "yarn format:source && yarn format:examples",
|
||||
"prettier:diff": "yarn nit:source && yarn nit:examples",
|
||||
"test": "jest"
|
||||
"test": "jest",
|
||||
"start": "cd website && yarn start"
|
||||
},
|
||||
"lint-staged": {
|
||||
"linters": {
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@
|
|||
|
||||
const React = require('react');
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const siteConfig = require(process.cwd() + '/siteConfig.js');
|
||||
const translate = require('../../server/translate.js').translate;
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@
|
|||
|
||||
const React = require('react');
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const GridBlock = CompLibrary.GridBlock;
|
||||
const siteConfig = require(process.cwd() + '/siteConfig.js');
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@
|
|||
|
||||
const React = require('react');
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const GridBlock = CompLibrary.GridBlock;
|
||||
const siteConfig = require(process.cwd() + '/siteConfig.js');
|
||||
|
|
@ -72,7 +73,7 @@ class HomeSplash extends React.Component {
|
|||
|
||||
class Index extends React.Component {
|
||||
render() {
|
||||
let language = this.props.language || 'en';
|
||||
const language = this.props.language || 'en';
|
||||
const showcase = siteConfig.users.filter(user => user.pinned).map(user => (
|
||||
<a href={user.infoLink} key={user.infoLink}>
|
||||
<img src={user.image} alt={user.caption} title={user.caption} />
|
||||
|
|
@ -226,7 +227,7 @@ class Index extends React.Component {
|
|||
</Container>
|
||||
<div className="productShowcaseSection paddingBottom">
|
||||
<h2>
|
||||
<translate>Who's Using Docusaurus?</translate>
|
||||
<translate>Who is Using Docusaurus?</translate>
|
||||
</h2>
|
||||
<p>
|
||||
<translate>
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@
|
|||
|
||||
const React = require('react');
|
||||
const CompLibrary = require('../../core/CompLibrary.js');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
const siteConfig = require(process.cwd() + '/siteConfig.js');
|
||||
const translate = require('../../server/translate.js').translate;
|
||||
|
|
@ -38,7 +39,7 @@ class Users extends React.Component {
|
|||
<translate>Who is using Docusaurus?</translate>
|
||||
</h1>
|
||||
<p>
|
||||
Docusaurus powers some of Facebook's popular{' '}
|
||||
Docusaurus powers some of Facebook's popular{' '}
|
||||
<a href="https://code.facebook.com/projects/">
|
||||
open source projects
|
||||
</a>.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@
|
|||
const React = require('react');
|
||||
|
||||
const CompLibrary = require('../../core/CompLibrary');
|
||||
|
||||
const Container = CompLibrary.Container;
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
|
|
|||
|
|
@ -31,6 +31,8 @@ window.addEventListener('load', function() {
|
|||
);
|
||||
|
||||
const clipboard = new ClipboardJS('.btnClipboard', {
|
||||
// Not gonna use the shorthand as this file is sent down to browsers without transpiling.
|
||||
/* eslint-disable object-shorthand */
|
||||
target: function(trigger) {
|
||||
return trigger.parentNode.querySelector('code');
|
||||
},
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue