diff --git a/docs/internals/home.md b/docs/internals/home.md new file mode 100644 index 0000000..90da5b4 --- /dev/null +++ b/docs/internals/home.md @@ -0,0 +1,13 @@ +--- +slug: /internals +sidebar_position: 1 +hide_table_of_contents: false +--- + +# Internals + +This contains instructions for how to do things with the scratch internals, such as add themes, change the mod brand, and more later like how to add blocks. + +Adding a theme to MistWarp: [Themes](./themes.md) + +Renaming a scratch mod: [Rename](./Rename.md) \ No newline at end of file diff --git a/docs/internals/rename.md b/docs/internals/rename.md new file mode 100644 index 0000000..3d1e093 --- /dev/null +++ b/docs/internals/rename.md @@ -0,0 +1,9 @@ +--- +slug: /internals/rename +hide_table_of_contents: false +--- + +# Renaming Your Mod + +Simply change the file below 🤷‍♀️
+https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/brand.js diff --git a/docs/vm/Adding Themes.md b/docs/internals/themes.md similarity index 79% rename from docs/vm/Adding Themes.md rename to docs/internals/themes.md index e896883..b9a44ed 100644 --- a/docs/vm/Adding Themes.md +++ b/docs/internals/themes.md @@ -1,23 +1,28 @@ +--- +slug: /internals/themes +hide_table_of_contents: false +--- + # Adding Themes You can add themes to any mod of tw pretty easily, heres a list of files to look at and from that you should be able to figure it out on your own 👍 -All theme files go in here:
+All theme files go in here:
https://github.com/MistWarp/scratch-gui/tree/develop/src/lib/themes/accent ## index.js -Insert the theme into here.
+Insert the theme into here.
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/themes/index.js#L3C1-L9C47 -Then Here
+Then Here
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/themes/index.js#L18C1-L34C3 -And finally here
+And finally here
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/themes/index.js#L159C1-L165C18 ## tw-theme-accent.jsx -Add the theme name in here
+Add the theme name in here
https://github.com/MistWarp/scratch-gui/blob/develop/src/components/menu-bar/tw-theme-accent.jsx#L10C1-L10C157 Finally add the theme into the "options" variable in the file above diff --git a/docs/vm/Rename.md b/docs/vm/Rename.md deleted file mode 100644 index af19870..0000000 --- a/docs/vm/Rename.md +++ /dev/null @@ -1,5 +0,0 @@ -# Renaming Your Mod - - -Simply change the file below 🤷‍♀️ -https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/brand.js diff --git a/docs/website/javascript.md b/docs/website/javascript.md index 1904331..51e4ec6 100644 --- a/docs/website/javascript.md +++ b/docs/website/javascript.md @@ -30,4 +30,10 @@ vm.enableDebug(); Then the JavaScript will be logged to the console when it gets compiled. If you don't know what a "JavaScript console" is or how to access it, then it's in your best interest to not look at the generated JavaScript anyways. + + +MistWarp has en extra feature, that allows you to disable this: +```js +vm.disableDebug() +``` diff --git a/docusaurus.config.js b/docusaurus.config.js index c7369b3..9b0d0c5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,16 +1,16 @@ /** @type {import('@docusaurus/types').DocusaurusConfig} */ module.exports = { - title: 'TurboWarp Documentation', - url: 'https://docs.turbowarp.org', + title: 'MistWarp Documentation', + url: 'https://docs.warp.mistium.com', baseUrl: '/', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - organizationName: 'TurboWarp', + organizationName: 'MistWarp', projectName: 'docs', trailingSlash: false, themeConfig: { navbar: { - title: 'TurboWarp Documentation', + title: 'MistWarp Documentation', items: [ { href: '/packager/', @@ -23,12 +23,17 @@ module.exports = { position: 'left' }, { - href: 'https://turbowarp.org/', - label: 'TurboWarp', + href: '/internals/', + label: 'Internals', + position: 'left' + }, + { + href: 'https://warp.mistium.com/', + label: 'MistWarp', position: 'right' }, { - href: 'https://github.com/TurboWarp', + href: 'https://github.com/MistWarp', label: 'GitHub', position: 'right', }, @@ -55,7 +60,7 @@ module.exports = { docs: { sidebarPath: require.resolve('./sidebars.js'), routeBasePath: '/', - editUrl: 'https://github.com/TurboWarp/docs/edit/master/', + editUrl: 'https://github.com/MistWarp/docs/edit/master/', breadcrumbs: false, }, theme: { diff --git a/sidebars.js b/sidebars.js index 0aa21d2..550cacd 100644 --- a/sidebars.js +++ b/sidebars.js @@ -63,5 +63,10 @@ module.exports = { 'packager/dynamic-stage-resize', 'packager/special-cloud-behaviors', 'packager/offline', + ], + internals: [ + 'internals/home', + 'internals/themes', + 'internals/rename' ] };