-
Notifications
You must be signed in to change notification settings - Fork 66
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
docs update : Installation copy-assets script #646
Merged
stevejpurves
merged 2 commits into
jupyter-book:main
from
shaielc:enhancement/thebe-lite-installation-npm
Jun 26, 2023
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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
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,67 @@ | ||
#!/usr/bin/node | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
const glob = require('glob'); | ||
|
||
if (process.argv.length < 3) { | ||
console.error('Usage: node copyThebeAssets.cjs <output_dir>'); | ||
process.exit(1); | ||
} | ||
|
||
const outputDir = process.argv[2]; | ||
|
||
if (!fs.existsSync(outputDir)) { | ||
console.log(`Output directory ${outputDir} does not exist, creating...`); | ||
fs.mkdirSync(outputDir, { recursive: true }); | ||
} | ||
|
||
console.log('Copying thebe assets...'); | ||
|
||
try { | ||
require.resolve('thebe-core'); | ||
} catch (err) { | ||
console.error('thebe-core not found, please run `npm install` in the theme directory.'); | ||
process.exit(1); | ||
} | ||
|
||
let usingThebeLite = false | ||
try { | ||
require.resolve('thebe-lite'); | ||
usingThebeLite = true | ||
} catch (err) { | ||
console.error('thebe-lite not found, please run `npm install` in the theme directory.'); | ||
} | ||
|
||
let assets = []; | ||
|
||
const pathToThebeCoreLibFolder = path.resolve( | ||
path.dirname(require.resolve('thebe-core')), | ||
'..', | ||
'lib', | ||
); | ||
const thebeCoreFiles = glob.sync(path.join(pathToThebeCoreLibFolder, '*.js')); | ||
|
||
assets = [ | ||
...thebeCoreFiles, | ||
path.join(pathToThebeCoreLibFolder, 'thebe-core.css'), | ||
]; | ||
|
||
if (usingThebeLite) { | ||
const pathToThebeLite = path.dirname(require.resolve('thebe-lite')); | ||
const thebeLiteFiles = glob.sync(path.join(pathToThebeLite, '*.js')); | ||
|
||
assets = [...assets, ...thebeLiteFiles] | ||
} | ||
|
||
console.log('Found thebe assets:'); | ||
console.log(assets); | ||
console.log(`Copying assets to ${outputDir} now...`); | ||
|
||
for (const asset of assets) { | ||
const basename = path.basename(asset); | ||
const dest = path.join(outputDir, basename); | ||
fs.copyFileSync(asset, dest); | ||
console.log(`Copied ${basename} to ${dest}`); | ||
} | ||
|
||
console.log('Done.'); |
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 |
---|---|---|
|
@@ -107,5 +107,8 @@ | |
}, | ||
"nohoist": [ | ||
"requirejs" | ||
] | ||
], | ||
"bin": { | ||
"copy-thebe-assets": "./bin/copy-thebe-assets.cjs" | ||
} | ||
} |
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
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.
This is great. I am using this over in another myst-theme as well, and it will be nice to not have to copy this script all over the place!