-
-
Notifications
You must be signed in to change notification settings - Fork 8.4k
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
feat(v2): official CodeSandbox support #3717
Merged
Merged
Changes from 5 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
4a6797c
feat:added support for codesandbox
sammychinedu2ky d390eb3
Merge https://github.com/facebook/docusaurus
sammychinedu2ky b197406
added sandbox config file
sammychinedu2ky 0f7529f
feat:added script to generate template for codesandbox
sammychinedu2ky d931386
added examples:generate script to package.json file
sammychinedu2ky f67db98
added failing path to eslintignore
sammychinedu2ky 2a5776e
added script to eslintignore
sammychinedu2ky 086cd7b
Merge https://github.com/facebook/docusaurus
sammychinedu2ky 23d2774
added cleaning feature to script
sammychinedu2ky a7cf6b6
deleted sandbox script in root
sammychinedu2ky a5dacb0
changed comment in codesandboxscript file
sammychinedu2ky bd3122a
Merge branch 'sandbox'
sammychinedu2ky 691d347
update codesandboxscript.js + revert bad package.json changes
slorber 3868e8f
eslint should check codesandboxscript
slorber File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| let {readFileSync, writeFileSync, copyFileSync, readdir} = require('fs'); | ||
| let {execSync} = require('child_process'); | ||
| // get the list of all available templates | ||
| readdir('./packages/docusaurus-init/templates', (err, data) => { | ||
| let templates = data.filter((i) => i !== 'README.MD'); | ||
| templates.forEach((template) => { | ||
| try { | ||
| console.log( | ||
| `generating ${template} template for codesandbox in the examples folder...`, | ||
| ); | ||
| // run the docusaurus script to bootstrap the template in the examples folder | ||
| execSync( | ||
| `node ./packages/docusaurus-init/bin/index.js init examples/${template} ${template}`, | ||
| ); | ||
| //read the content of the package.json | ||
| let getPackagedDotJson = readFileSync( | ||
| `examples/${template}/package.json`, | ||
| ); | ||
| // parse it into an object | ||
| let toJSON = JSON.parse(getPackagedDotJson.toString()); | ||
| // attach the dev script which would be used in code sandbox by default | ||
| toJSON.scripts.dev = 'docusaurus start'; | ||
|
|
||
| //rewrite the package.json file with the new edit | ||
| writeFileSync( | ||
| `./examples/${template}/package.json`, | ||
| JSON.stringify(toJSON, null, 1), | ||
| ); | ||
|
|
||
| /*copy the sandbox config file from the root of docusaurus to the root | ||
| of template in the examples folder*/ | ||
| copyFileSync( | ||
| './sandbox.config.json', | ||
| `./examples/${template}/sandbox.config.json`, | ||
| ); | ||
| console.log('done'); | ||
| } catch (error) { | ||
| console.log(error); | ||
| } | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,34 @@ | ||
| { | ||
| "name": "bootstrap", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "docusaurus": "docusaurus", | ||
| "start": "docusaurus start", | ||
| "dev": "docusaurus start", | ||
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "serve": "docusaurus serve" | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "2.0.0-alpha.66", | ||
| "@docusaurus/preset-bootstrap": "2.0.0-alpha.66", | ||
| "@mdx-js/react": "^1.5.8", | ||
| "classnames": "^2.2.6", | ||
| "react": "^16.8.4", | ||
| "react-dom": "^16.8.4" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| "name": "examples-bootstrap", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "docusaurus": "docusaurus", | ||
| "start": "docusaurus start", | ||
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "serve": "docusaurus serve", | ||
| "dev": "docusaurus start" | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "2.0.0-alpha.66", | ||
| "@docusaurus/preset-bootstrap": "2.0.0-alpha.66", | ||
| "@mdx-js/react": "^1.5.8", | ||
| "classnames": "^2.2.6", | ||
| "react": "^16.8.4", | ||
| "react-dom": "^16.8.4" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,35 @@ | ||
| { | ||
| "name": "classic", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "docusaurus": "docusaurus", | ||
| "start": "docusaurus start", | ||
| "dev": "docusaurus start", | ||
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "serve": "docusaurus serve" | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "2.0.0-alpha.66", | ||
| "@docusaurus/preset-classic": "2.0.0-alpha.66", | ||
| "@mdx-js/react": "^1.5.8", | ||
| "clsx": "^1.1.1", | ||
| "react": "^16.8.4", | ||
| "react-dom": "^16.8.4" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| "name": "examples-classic", | ||
| "version": "0.0.0", | ||
| "private": true, | ||
| "scripts": { | ||
| "docusaurus": "docusaurus", | ||
| "start": "docusaurus start", | ||
| "build": "docusaurus build", | ||
| "swizzle": "docusaurus swizzle", | ||
| "deploy": "docusaurus deploy", | ||
| "serve": "docusaurus serve", | ||
| "clear": "docusaurus clear", | ||
| "dev": "docusaurus start" | ||
| }, | ||
| "dependencies": { | ||
| "@docusaurus/core": "2.0.0-alpha.66", | ||
| "@docusaurus/preset-classic": "2.0.0-alpha.66", | ||
| "@mdx-js/react": "^1.6.21", | ||
| "clsx": "^1.1.1", | ||
| "react": "^16.8.4", | ||
| "react-dom": "^16.8.4" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.5%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why use 1 space indentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry about that would change it to 2