chore: Move docs out of GitBook

one-dark · Jun 5, 2020 · adb98e5 · adb98e5
2 parents 4bc9423 + 9b4a07d
commit adb98e5
Show file tree

Hide file tree

Showing 25 changed files with 44 additions and 155 deletions.
diff --git a/.gitbook.yml b/.gitbook.yml
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# Contributing
+
+## Installation
+
+Run the following commands to clone the repository for this theme and install all necessary dependencies.
+
+```bash
+git clone git@github.com:one-dark/vscode-one-dark-theme.git
+cd vscode-one-dark-theme
+npm install
+```
+
+## Testing the theme
+
+To run the theme, open the project in VS Code and run the `Debug: Start Debugging` command. When you start debugging, a new VS Code test instance \(heretofore referred to as the "test instance"\) will be launched with all your extensions disabled and the One Dark theme enabled and selected. The TypeScript compiler will also start in watch mode and compile any changes you make to the theme. After making your changes, run the `Debug: Restart` command to restart the test instance with the changes you made.
+
+### Live reload using nodemon
+
+This project is configured to allow live theme reloading using `nodemon`. This will update the theme colors in the test instance to allow you to immediately see how your changes will look without having to restart the test instance. To utilize this feature, run the following command before you start debugging.
+
+```bash
+npm run theme:watch
+```
+
+## Color Guidelines
+
+To increase theme consistency, the following colors should be used for all syntax highlighting colors. Editor colors should use this color palette when possible, but the editor colors are not required to strictly follow this color palette.
+
+| Name       | Value    | Preview                     | Name        | Value    | Preview                      |
+| :--------- | :------- | :-------------------------- | :---------- | :------- | :--------------------------- |
+| **chalky** | \#e5c07b | ![](docs/colors/chalky.jpg) | **malibu**  | \#61afef | ![](docs/colors/malibu.jpg)  |
+| **coral**  | \#e06c75 | ![](docs/colors/coral.jpg)  | **sage**    | \#98c379 | ![](docs/colors/sage.jpg)    |
+| **cyan**   | \#56b6c2 | ![](docs/colors/cyan.jpg)   | **stone**   | \#5c6370 | ![](docs/colors/stone.jpg)   |
+| **error**  | \#f44747 | ![](docs/colors/error.jpg)  | **violet**  | \#c678dd | ![](docs/colors/violet.jpg)  |
+| **ivory**  | \#abb2bf | ![](docs/colors/ivory.jpg)  | **whiskey** | \#d19a66 | ![](docs/colors/whiskey.jpg) |
diff --git a/README.md b/README.md
@@ -10,66 +10,29 @@
 
 ![Code example](static/screenshots/code.png)
 
-## Basic Configuration 🔧
+## Configuration
 
 This theme comes with several configuration settings to allow you to customize the theme to your preference. We currently support the following settings:
 
-- **Vivid** - Uses the [One Dark Vivid](https://atom.io/themes/one-dark-vivid-syntax) color palette instead of the default color palette.
-- **Italic** - When enabled, uses italic font for keywords. Note that some scopes \(i.e. markdown block quotes\) are styled with italic font even when this setting is disabled.
-- **Bold** - When enabled, uses bold font for namespace, class, and function names. Note that some scopes \(i.e. markdown headers\) are styled with bold font even when this setting is disabled.
+- **Italic** - When enabled, uses italic font for keywords. Note that some scopes \(e.g. markdown block quotes\) are styled with italic font even when this setting is disabled.
+- **Bold** - When enabled, uses bold font for namespace, class, and function names. Note that some scopes \(e.g. markdown headers\) are styled with bold font even when this setting is disabled.
 
 To access these configuration settings, open the VS Code settings page and search for "One Dark".
 
 ![Theme settings](static/screenshots/settings.png)
 
-This theme ships with the italic setting turned on by default and the other settings turned off by default, but you can adjust the settings to any combination you like. After updating the settings, you will be prompted to reload the window to apply the configuration changes.
+This theme ships with the italic setting turned on by default and the other settings turned off by default, but you can adjust the settings to any combination you like.
 
-![Theme settings reload prompt](static/screenshots/reload-prompt.png)
+## Vivid Variant
 
-## Advanced Configuration 🧰
+In addition to the default color pallette, this theme ships with a vivid variant which uses the [One Dark Vivid](https://atom.io/themes/one-dark-vivid-syntax) pallette. This can be enabled by selecting "One Dark Vivid" from the Color Theme dropdown in your VS Code settings.
 
-VS Code allows users to fully customize themes to their liking. If you wish to adjust the editor colors, use the `workbench.colorCustomizations` setting in your `settings.json` file. An example of this is shown below.
+![Vivid setting](static/screenshots/vivid-setting.png)
 
-```json
-"workbench.colorCustomizations": {
-  "tab.activeBackground": "#282c34",
-  "activityBar.background": "#282c34",
-  "sideBar.background": "#282c34"
-}
-```
-
-To customize the syntax highlighting, use the `editor.tokenColorCustomizations` setting. An example of this is shown below.
-
-```json
-"editor.tokenColorCustomizations": {
-  "[One Dark]": {
-    "textMateRules": [
-      {
-        "scope": ["source.python"],
-        "settings": {
-          "foreground": "#e06c75"
-        }
-      }
-    ]
-  }
-}
-```
-
-For more information, see the official [theme color reference](https://code.visualstudio.com/docs/getstarted/theme-color-reference) or [color theme documentation](https://code.visualstudio.com/docs/getstarted/themes).
-
-## Further Documentation 📖
-
-Check out the [docs](https://one-dark.gitbook.io/vscode) for manual installation instructions, additional screenshots, and contributing guidelines.
-
-- [Installation](https://one-dark.gitbook.io/vscode/installation)
-- [Screenshots](https://one-dark.gitbook.io/vscode/screenshots)
-- [Contributing](https://one-dark.gitbook.io/vscode/contributing)
-
-## Thanks 🙏
+## Thanks
 
 - Thanks to [Binaryify](https://github.com/Binaryify) for his work on the theme this project was originally based on.
-- Thanks to [VS Code Nebula Theme](https://github.com/eating-coleslaw/vscode-nebula-theme) for being a great example of how to build a VS Code theme using configuration settings.
-- Thanks to GitBook for hosting the docs!
+- Thanks to [VS Code Nebula Theme](https://github.com/eating-coleslaw/vscode-nebula-theme) for the inspiration for creating a configurable color theme.
 
 ## Contributors ✨
 

diff --git a/docs/.gitbook/assets/2019-10-26_11-41-02 (1).png b/docs/.gitbook/assets/2019-10-26_11-41-02 (1).png
diff --git a/docs/.gitbook/assets/2019-10-26_11-41-02.png b/docs/.gitbook/assets/2019-10-26_11-41-02.png
diff --git a/docs/.gitbook/assets/2019-10-26_12-19-19.png b/docs/.gitbook/assets/2019-10-26_12-19-19.png
diff --git a/docs/.gitbook/assets/2019-10-26_16-03-34.png b/docs/.gitbook/assets/2019-10-26_16-03-34.png
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/.gitbook/assets/chalky.jpg → docs/colors/chalky.jpg b/docs/.gitbook/assets/chalky.jpg → docs/colors/chalky.jpg
diff --git a/docs/.gitbook/assets/coral.jpg → docs/colors/coral.jpg b/docs/.gitbook/assets/coral.jpg → docs/colors/coral.jpg
diff --git a/docs/.gitbook/assets/cyan.jpg → docs/colors/cyan.jpg b/docs/.gitbook/assets/cyan.jpg → docs/colors/cyan.jpg
diff --git a/docs/.gitbook/assets/error.jpg → docs/colors/error.jpg b/docs/.gitbook/assets/error.jpg → docs/colors/error.jpg
diff --git a/docs/.gitbook/assets/ivory.jpg → docs/colors/ivory.jpg b/docs/.gitbook/assets/ivory.jpg → docs/colors/ivory.jpg
diff --git a/docs/.gitbook/assets/malibu.jpg → docs/colors/malibu.jpg b/docs/.gitbook/assets/malibu.jpg → docs/colors/malibu.jpg
diff --git a/docs/.gitbook/assets/sage.jpg → docs/colors/sage.jpg b/docs/.gitbook/assets/sage.jpg → docs/colors/sage.jpg
diff --git a/docs/.gitbook/assets/stone.jpg → docs/colors/stone.jpg b/docs/.gitbook/assets/stone.jpg → docs/colors/stone.jpg
diff --git a/docs/.gitbook/assets/violet.jpg → docs/colors/violet.jpg b/docs/.gitbook/assets/violet.jpg → docs/colors/violet.jpg
diff --git a/docs/.gitbook/assets/whiskey.jpg → docs/colors/whiskey.jpg b/docs/.gitbook/assets/whiskey.jpg → docs/colors/whiskey.jpg
diff --git a/docs/contributing.md b/docs/contributing.md
diff --git a/docs/installation.md b/docs/installation.md
diff --git a/docs/screenshots.md b/docs/screenshots.md
diff --git a/static/screenshots/reload-prompt.png b/static/screenshots/reload-prompt.png
diff --git a/static/screenshots/settings.png b/static/screenshots/settings.png
diff --git a/static/screenshots/vivid-setting.png b/static/screenshots/vivid-setting.png