Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade to Docusaurus v2 (closes #105) #106

Merged
merged 6 commits into from
Apr 5, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Intial work migrating to Docusaurus v2 (ref #105)
  • Loading branch information
phated committed Apr 4, 2020
commit a505682375320c13eb8a8a654b3d5215a11ec97c
29 changes: 25 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,29 @@
# dependencies
node_modules

# production
build

# generated files
.docusaurus
.cache-loader

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
*.log
node_modules
docs
converted-docs

# lock
package-lock.json
yarn.lock
website/build

# generated
docs
converted-docs
77 changes: 0 additions & 77 deletions website/core/Footer.js

This file was deleted.

115 changes: 115 additions & 0 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
'use strict';

var isProd = process.env.NODE_ENV === 'production';

module.exports = {
title: 'gulp.js',
favicon: 'img/favicon.png',
url: 'https://gulpjs.com/',
baseUrl: '/',
tagline: 'The streaming build system',
// Used by the deployment
organizationName: 'gulpjs',
projectName: 'gulpjs.github.io',
// The theme
themeConfig: {
disableDarkMode: true,
sidebarCollapsible: false,
navbar: {
logo: {
alt: 'gulp',
src: 'img/gulp.svg',
},
links: [
{ to: 'getting-started/quick-start',
label: 'Getting Started',
position: 'left',
},
{ to: 'api/concepts',
label: 'API',
position: 'left',
},
{ href: 'https://gulpjs.com/plugins',
label: 'Plugins',
position: 'left',
},
{ href: 'https://twitter.com/gulpjs',
label: 'Twitter',
position: 'right'
},
{ href: 'https://medium.com/gulpjs',
label: 'Blog',
position: 'right'
},
]
},
footer: {
links: [
{ items: [
{ html: '<img src="/img/gulp.svg" alt="gulp" href="/" />' }
]
},
{ title: 'Docs',
items: [
{ to: 'getting-started/quick-start',
label: 'Getting Started',
},
{ to: 'api/concepts',
label: 'API',
},
]
},
{ title: 'Community',
items: [
{ href: 'https://stackoverflow.com/questions/tagged/gulp',
label: 'Stack Overflow',
},
{ href: 'https://twitter.com/gulpjs',
label: 'Twitter',
}
]
},
{ title: 'More',
items: [
{ href: 'https://github.com/gulpjs/gulp',
label: 'GitHub',
}
]
},
],
copyright: `Copyright © ${new Date().getFullYear()} GulpJS`,
},
prism: {
// One of:
// dracula, duotoneDark, duotoneLight, github, nightOwl, nightOwlLight,
// oceanicNext, palenight, shad esOfPurple, ultramin, vsDark
theme: require('prism-react-renderer/themes/vsDark'),
},
algolia: {
apiKey: 'a6ef919bce0b83de1bcbad1d4ef753f8',
indexName: 'gulpjs',
algoliaOptions: {} // Optional, if provided by Algolia
},
googleAnalytics: {
trackingID: 'UA-128126650-1',
},
gtag: {
trackingID: 'UA-128126650-1',
},
},
themes: [
['@docusaurus/theme-classic', {
customCss: require.resolve('./src/css/docs.css')
}],
['@docusaurus/theme-search-algolia', {}]
],
plugins: [
['@docusaurus/plugin-content-docs', {
path: '../converted-docs',
sidebarPath: require.resolve('./sidebars.json'),
}],
isProd && ['@docusaurus/plugin-google-analytics', {}],
isProd && ['@docusaurus/plugin-google-gtag', {}],
isProd && ['@docusaurus/plugin-sitemap', {}],
]
};
36 changes: 28 additions & 8 deletions website/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,34 @@
{
"scripts": {
"examples": "docusaurus-examples",
"start": "docusaurus-start",
"build": "docusaurus-build",
"publish-gh-pages": "docusaurus-publish",
"write-translations": "docusaurus-write-translations",
"version": "docusaurus-version",
"rename-version": "docusaurus-rename-version"
"start": "docusaurus start",
"build": "docusaurus build",
"swizzle": "docusaurus swizzle",
"deploy": "docusaurus deploy"
},
"dependencies": {
"react": "^16.13.1",
"react-dom": "^16.13.1",
"remark-admonitions": "^1.2.1"
},
"devDependencies": {
"docusaurus": "^1.6.0"
"@docusaurus/core": "^2.0.0-alpha.50",
"@docusaurus/plugin-content-docs": "^2.0.0-alpha.50",
"@docusaurus/plugin-google-analytics": "^2.0.0-alpha.50",
"@docusaurus/plugin-google-gtag": "^2.0.0-alpha.50",
"@docusaurus/plugin-sitemap": "^2.0.0-alpha.50",
"@docusaurus/theme-classic": "^2.0.0-alpha.50",
"@docusaurus/theme-search-algolia": "^2.0.0-alpha.50"
},
"browserslist": {
"production": [
">0.2%",
"not dead",
"not op_mini all"
],
"development": [
"last 1 chrome version",
"last 1 firefox version",
"last 1 safari version"
]
}
}
58 changes: 0 additions & 58 deletions website/pages/en/help.js

This file was deleted.

45 changes: 0 additions & 45 deletions website/siteConfig.js

This file was deleted.

Loading