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

refactor: capitalize comments (#7188)

Browse source 
* refactor: capitalize comments

* revert...
This commit is contained in:
Joshua Chen 2022-04-17 16:39:11 +08:00 • committed by GitHub
parent 200009008b
commit fa1ce230ea
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
99 changed files with 241 additions and 350 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/_dogfooding/docs-tests-sidebars.js
View file

@ -87,7 +87,7 @@ const sidebars = {
collapsed: false,
collapsible: false,
items: [
// title
// Title
{
type: 'html',
value: 'Some Text',

6
website/_dogfooding/dogfooding.config.js
View file

@ -22,7 +22,7 @@ exports.dogfoodingThemeInstances = dogfoodingThemeInstances;
/** @type {import('@docusaurus/types').PluginConfig[]} */
const dogfoodingPluginInstances = [
[
'content-docs', // dogfood shorthand
'content-docs', // Shorthand
/** @type {import('@docusaurus/plugin-content-docs').Options} */
({
id: 'docs-tests',
@ -52,7 +52,7 @@ const dogfoodingPluginInstances = [
],
[
'@docusaurus/plugin-content-blog', // dogfood longhand
'@docusaurus/plugin-content-blog', // Longhand
/** @type {import('@docusaurus/plugin-content-blog').Options} */
({
id: 'blog-tests',
@ -75,7 +75,7 @@ const dogfoodingPluginInstances = [
],
[
require.resolve('@docusaurus/plugin-content-pages'), // dogfood longhand resolve
require.resolve('@docusaurus/plugin-content-pages'), // Full path
/** @type {import('@docusaurus/plugin-content-pages').Options} */
({
id: 'pages-tests',

12
website/_dogfooding/testSwizzleThemeClassic.mjs
View file

@ -68,16 +68,16 @@ Please double-check or clean up these components from the config:
// TODO temp workaround: non-comps should be forbidden to wrap
if (action === 'wrap') {
const WrapBlacklist = [
'Layout', // due to theme-fallback?
const WrapBlocklist = [
'Layout', // Due to theme-fallback?
];
componentNames = componentNames.filter((componentName) => {
const blacklisted = WrapBlacklist.includes(componentName);
if (!WrapBlacklist) {
logger.warn(`${componentName} is blacklisted and will not be wrapped`);
const blocked = WrapBlocklist.includes(componentName);
if (blocked) {
logger.warn(`${componentName} is blocked and will not be wrapped`);
}
return !blacklisted;
return !blocked;
});
}

20
website/docusaurus.config.js
View file

@ -170,8 +170,8 @@ const config = {
({
fromExtensions: ['html'],
createRedirects(routePath) {
// redirect to /docs from /docs/introduction,
// as introduction has been made the home doc
// Redirect to /docs from /docs/introduction, as introduction has been
// made the home doc
if (allDocHomesPaths.includes(routePath)) {
return [`${routePath}/introduction`];
}
@ -195,13 +195,15 @@ const config = {
],
[
'ideal-image',
{
/** @type {import('@docusaurus/plugin-ideal-image').PluginOptions} */
({
quality: 70,
max: 1030, // max resized image's size.
min: 640, // min resized image's size. if original is lower, use that size.
steps: 2, // the max number of images generated between min and max (inclusive)
// disableInDev: false,
},
max: 1030,
min: 640,
steps: 2,
// Use false to debug, but it incurs huge perf costs
disableInDev: true,
}),
],
[
'pwa',
@ -413,7 +415,7 @@ const config = {
label: 'Tests',
docsPluginId: 'docs-tests',
},
// right
// Right
{
type: 'docsVersionDropdown',
position: 'right',

2
website/testCSSOrder.mjs
View file

@ -47,7 +47,7 @@ const EXPECTED_CSS_MARKERS = [
'.test-marker-theme-layout',
'.test-marker-site-index-page',
// lazy loaded lib
// Lazy-loaded lib
'.DocSearch-Modal',
];

2
website/waitForCrowdin.mjs
View file

@ -24,7 +24,7 @@ const pollInterval = 5000;
const timeout = 5 * 60 * 1000;
const projectId = 428890;
const token = process.env.CROWDIN_PERSONAL_TOKEN; // set on Netlify
const token = process.env.CROWDIN_PERSONAL_TOKEN; // Set on Netlify
const translations = new Translations({token});