|
| 1 | + |
| 2 | + |
| 3 | +# Material DevTools Collection |
| 4 | + |
| 5 | +This is a porting of the famous Material Theme (https://www.material-theme.com) for Chrome DevTools. It completely redesigns the Chrome DevTools panels to the |
| 6 | +Material Theme Colors. And just like its inspiration, it also provides options to switch to other themes as well in the blink of an eye! |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +### Available Themes |
| 11 | + |
| 12 | +- Material Oceanic |
| 13 | +- Material Darker |
| 14 | +- Material Lighter |
| 15 | +- Material Palenight |
| 16 | +- Material Deep Ocean |
| 17 | +- Material Forest |
| 18 | +- Material Sky Blue |
| 19 | +- Material Sandy Beach |
| 20 | +- Material Volcano |
| 21 | +- Material Space |
| 22 | +- Monokai Pro |
| 23 | +- Dracula |
| 24 | +- GitHub |
| 25 | +- GitHub Dark |
| 26 | +- Arc Dark |
| 27 | +- Atom One Dark |
| 28 | +- Atom One Light |
| 29 | +- Night Owl |
| 30 | +- Light Owl |
| 31 | +- Solarized Dark |
| 32 | +- Solarized Light |
| 33 | +- Moonlight |
| 34 | +- SynthWave '84 |
| 35 | + |
| 36 | +### Other Features |
| 37 | + |
| 38 | +- Custom Font Family |
| 39 | +- Custom Font Size |
| 40 | +- Accent Color |
| 41 | +- Accent Scrollbars |
| 42 | + |
| 43 | +## Installation |
| 44 | + |
| 45 | +1. Open Developer Tools |
| 46 | +2. Open the Settings > Experiments > "Allow extensions to load custom stylesheets" |
| 47 | +3. Close and reopen the DevTools |
| 48 | + |
| 49 | +## Local development |
| 50 | + |
| 51 | +1. Clone the project |
| 52 | + |
| 53 | +```bash |
| 54 | + git clone https://github.com/mallowigi/material-dev-tools |
| 55 | +``` |
| 56 | + |
| 57 | +2. Install dependencies |
| 58 | + |
| 59 | +```bash |
| 60 | + npm install |
| 61 | +``` |
| 62 | + |
| 63 | +3. Start the server |
| 64 | + |
| 65 | +```bash |
| 66 | + npm run dev |
| 67 | +``` |
| 68 | + |
| 69 | +4. Open the Chrome Extensions Management Page. |
| 70 | + |
| 71 | +5. Select _Load unpacked extension_ |
| 72 | + |
| 73 | +6. Select the `build/chrome-mv3/dev` directory. |
| 74 | + |
| 75 | +7. Verify that the extension is loaded and that the icon show up in the Toolbar. |
| 76 | + |
| 77 | +8. Run the styles compiler |
| 78 | + |
| 79 | +```bash |
| 80 | +npm run styles |
| 81 | +``` |
| 82 | + |
| 83 | +## Themes Management |
| 84 | + |
| 85 | +If you want to add new themes or modify the existing themes: |
| 86 | + |
| 87 | +1. Open the `public/themes.yml` file |
| 88 | + |
| 89 | +2. Modify themes |
| 90 | + |
| 91 | +3. Run `gulp themes` |
| 92 | + |
| 93 | +```bash |
| 94 | +npm run themes |
| 95 | +``` |
| 96 | + |
| 97 | +4. Reopen the settings to reload the colors |
| 98 | + |
| 99 | +5. Reopen the devtools |
| 100 | + |
| 101 | +## Important files |
| 102 | + |
| 103 | +- `/new/default.scss` -> SCSS variables reading the CSS variables generated by Svelte |
| 104 | +- `/new/light.scss`, `/new/dark.scss` -> the dark and light equivalents |
| 105 | +- `/src/utils/styleBuilder.ts` -> file that generates the `:root` CSS variables from the `themes.json` |
| 106 | +- `/src/devtools.svelte` -> generates the `:root` inside the Devtools panel |
| 107 | +- `public/themes.yml` -> Themes Manifest, will generate `themes.json` used by the extension |
| 108 | + |
| 109 | +## FAQ |
| 110 | + |
| 111 | +#### I have installed the extension but nothing happened. |
| 112 | + |
| 113 | +Make sure you've enabled the Chromium Experiment `Allow extensions to load custom stylesheets`, and reload the DevTools. |
| 114 | + |
| 115 | +#### I selected the X theme but it looks ugly! |
| 116 | + |
| 117 | +Please make sure you've selected the `DARK` or `LIGHT` theme in the DevTools settings, according to the selected theme. |
| 118 | + |
| 119 | +## Authors |
| 120 | + |
| 121 | +- [Elior Boukhobza](https://www.github.com/mallowigi) |
| 122 | +- [Mike King](https://github.com/micjamking) |
| 123 | + |
| 124 | +## Acknowledgements |
| 125 | + |
| 126 | +- [Prismo Framework](https://docs.plasmo.com/framework) |
| 127 | +- [Original concept](https://github.com/micjamking) |
| 128 | + |
| 129 | +## License |
| 130 | + |
| 131 | +[MIT](https://choosealicense.com/licenses/mit/) |
| 132 | + |
| 133 | +## Badges |
| 134 | + |
| 135 | +Add badges from somewhere like: [shields.io](https://shields.io/) |
| 136 | + |
| 137 | +[](https://choosealicense.com/licenses/mit/) |
| 138 | +[](https://opensource.org/licenses/) |
| 139 | +[](http://www.gnu.org/licenses/agpl-3.0) |
| 140 | + |
0 commit comments