-
Notifications
You must be signed in to change notification settings - Fork 29
Add guide for adding custom themes #133
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
Open
rabail-aamir
wants to merge
2
commits into
thoth-tech:main
Choose a base branch
from
rabail-aamir:doc-theme-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
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 hidden or 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 |
|---|---|---|
|
|
@@ -8,4 +8,4 @@ out/ | |
| splashkit/splashkit_autocomplete.json | ||
| generated/ | ||
| __pycache__/ | ||
| _framework/ | ||
| _framework/.DS_Store | ||
This file contains hidden or 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,50 @@ | ||
| # Adding a Custom Theme to SplashKit Online | ||
|
|
||
| The guide provides instructions for adding new themes to the SplashKit Online editor through theme.js and colors.css modifications and user interface updates for theme selection functionality. | ||
|
|
||
| ## Files Involved | ||
| - `javascript/UI/themes.js` | ||
| - `css/colours.css` | ||
| - `index.html` | ||
|
|
||
| ## Add Theme Colours to *theme.js* | ||
|
|
||
| Add your preferred color values to the themes object in javascript/UI/themes.js. | ||
|
|
||
| ```js | ||
| "myCustomTheme": { | ||
| "editorBackgroundColour": "#2e3440", | ||
| "editorKeyword": "#81a1c1", | ||
| "editorComment": "#616e88", | ||
| "editorLineNumber": "#d8dee9", | ||
| "editorGutterBackground": "#3b4252", | ||
| "editorString": "#a3be8c" | ||
| } | ||
| ``` | ||
|
|
||
|
|
||
| ## Theme Selector in *index.html* is updated | ||
|
|
||
| Make sure that this is updated, as this is resposible for enabling users to select the theme. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Small typo here: |
||
|
|
||
| ```html | ||
| <li style="margin-left:1rem"> | ||
| <div>Theme: </div> | ||
| <select id="themeSelection"></select> | ||
| </li> | ||
| ``` | ||
|
|
||
| ## CSS Variables in *colours.css* | ||
|
|
||
| The Themes system enables runtime modification of CSS variables through its functionality. The available variables exist within the css/colours.css file which you can access for viewing. | ||
|
|
||
| ```css | ||
| --editorKeyword | ||
| --editorComment | ||
| --editorLineNumber | ||
| --editorBackgroundColour | ||
| --editorString | ||
| --editorGutterBackground | ||
| --shadowColour | ||
| ``` | ||
|
|
||
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.
This
.gitignoreupdate seems unrelated to the documentation change in this PR. If it is not required for this task, it may be better to remove it and keep the PR focused.