Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Mistium committed Nov 9, 2024
1 parent 07b036b commit 907dcd2
Show file tree
Hide file tree
Showing 7 changed files with 56 additions and 18 deletions.
13 changes: 13 additions & 0 deletions docs/internals/home.md
Original file line number Diff line number Diff line change
@@ -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)
9 changes: 9 additions & 0 deletions docs/internals/rename.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
slug: /internals/rename
hide_table_of_contents: false
---

# Renaming Your Mod

Simply change the file below 🤷‍♀️ <br/>
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/brand.js
15 changes: 10 additions & 5 deletions docs/vm/Adding Themes.md → docs/internals/themes.md
Original file line number Diff line number Diff line change
@@ -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:<br>
All theme files go in here:<br/>
https://github.com/MistWarp/scratch-gui/tree/develop/src/lib/themes/accent

## index.js
Insert the theme into here.<br>
Insert the theme into here.<br/>
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/themes/index.js#L3C1-L9C47

Then Here<br>
Then Here<br/>
https://github.com/MistWarp/scratch-gui/blob/develop/src/lib/themes/index.js#L18C1-L34C3

And finally here<br>
And finally here<br/>
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<br>
Add the theme name in here<br/>
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
Expand Down
5 changes: 0 additions & 5 deletions docs/vm/Rename.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/website/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()
```
</details>
21 changes: 13 additions & 8 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -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/',
Expand All @@ -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',
},
Expand All @@ -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: {
Expand Down
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,10 @@ module.exports = {
'packager/dynamic-stage-resize',
'packager/special-cloud-behaviors',
'packager/offline',
],
internals: [
'internals/home',
'internals/themes',
'internals/rename'
]
};

0 comments on commit 907dcd2

Please sign in to comment.