Code Monkey home page Code Monkey logo

gray-matter's Introduction

Gray Matter

A pair of colour schemes for writing Markdown in Sublime Text, Visual Studio Code, and other .tmTheme editors. It takes aesthetic cues from popular minimalist writing apps and aims to lessen the visual impact of markdown punctuation. It also attempts to support the full range of Markdown syntax ranging from Markdown, MultiMarkdown, Github Flavoured Markdown, and Pandoc Markdown.

Light Theme

Light Theme

Dark Theme

Dark Theme

Sublime Text Installation

With Package Control

  1. Make sure that Package Control is already installed
  2. Choose Install Package from the Command Palette — Ctrl+Shift+P on Windows/Linux and ⇧⌘P on OS X
  3. Search for Gray Matter Color Schemes and hit Enter

Manual Install

  1. Clone or download the repo
  2. Choose Browse Packages from the Command Palette — Ctrl+Shift+P on Windows/Linux and ⇧⌘P on OS X
  3. Copy the repo folder into this directory

Setup

Note that this theme is specifically designed for Markdown. To configure Sublime Text such that this theme is always used for just Markdown files, first open up a Markdown file, and then in the menu bar open up the syntax-specific settings via Preferences > Settings - More > Syntax Specific - User.

Add in either:

"color_scheme": "Packages/Color Scheme - Gray Matter/Gray Matter Light.tmTheme",

Or:

"color_scheme": "Packages/Color Scheme - Gray Matter/Gray Matter Dark.tmTheme",

While in this file here are another few options you may want to consider in order to better match a more traditional Markdown text editor:

"draw_centered": true,
"font_size": 18,
"gutter": false,
"highlight_line": false,
"line_numbers": true,
"line_padding_bottom": 4,
"line_padding_top": 4,
"tab_size": 4,
"word_wrap": true,
"wrap_width": 90

This color scheme pairs well with Boxy Yesterday if you desire a similar aesthetic for the wider Sublime Text chrome.

Supported Sublime Syntaxes

Visual Studio Code Installation & Configuration

Currently the theme is available through the Visual Studio Marketplace. You can then activate it in the Preferences > Color Theme section of the menu.

Development

Tests

Tests use sublime_color_scheme_unit to test for regressions. Once installed (via Package Control) the :TestSuite command in the Command Palette will run the test set.

References

Building

A script builds the Dark version of the theme.

$ bash build.sh

Publishing

Sublime Text works with the .thTheme files in the root directory. To publish to Package Control just tag the version and push from master.

Visual Studio code uses the *-color-theme.json files in the root directory which contain a number of VSC-specific settings for the editor chrome and import the .tmTheme for basic syntax highlighting. To publish to the Visual Studio Marketplace (requires the vsce package from npm install):

$ vsce publish 1.2.0

Atom uses the .less files in gray-matter-X-syntax folders

Roadmap

  • Sublime Text Multimarkdown Grammars don't appear to exist for most footnote formats in-text such as [^ref] / [@Kullmann:2014bd 26] or for recognising the bottom reference to a footnote such as [^ref]: / [#Doe:2011]:.
  • Sublime Text Multimarkdown Grammars don't appear to exist for recognising the actual text part of an ATX style header
  • Sublime Text Multimarkdown Grammars don't appear to exist for getting the syntax elements (ie the 1. or -) for lists beyond the first item.

License

The MIT license.

Acknowledgements

This colour scheme is heavily influence by the visual style of Byword, iA Writer, and Ulysses.

gray-matter's People

Contributors

d2s avatar philipbelesky avatar simonhermann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

gray-matter's Issues

Byworded theme and non-markdown files

Hi, this looks great but when I change to the theme, all other files are not displayed my default color theme, which makes it pretty much unusable when you are switching a lot. Is it possible to use this only for markdown files?

Thanks!

Highlighting with VSCode

First of all: I LOVE THIS THEME. ❤️ ❤️ ❤️ Thank you for making it.

So, I'm not sure if this is an issue with the theme or vscode, but I've got some funky things happening when I select parts of words:

I highlighted "color" but now it shows a blue box around "background-color". so i can't see that I am only selecting the word color.
Screen Shot 2019-05-18 at 10 42 29 AM

here I just clicked on the classname and it put this darker blue behind it making the gray text illegible:
Screen Shot 2019-05-18 at 10 42 13 AM

Publish extension to Open VSX

Hi, Could you add this extension to Open VSX to make it available for VSCodium

Open VSX is a vendor-neutral open-source alternative to the Visual Studio Marketplace. It provides a server application that manages VS Code extensions in a database, a web application similar to the VS Code Marketplace, and a command-line tool for publishing extensions similar to vsce. - eclipse/openvsx: An open-source registry for VS Code extensions

To publish it, it's just a few steps for the maintainer to do following this guide.

VS Code Status Bar Coloring

Hi Philip!

First of all thanks for the great theme! 👏
While working with the light version in VS Code i just encountered an issue with the status bar coloring:
image

I just submitted a PR (#4) for this.

All the best, Bernhard

Open VSX Listing: Signing the Publisher Agreement

Thank you for being part of the Open VSX community by adding your extensions to the Open VSX Registry. Please note that the service was recently transferred to the Eclipse Foundation and urgent action on your part is needed so we can continue to list your extensions. To ensure uninterrupted service, please sign the Eclipse Publisher Agreement as soon as possible.

Regrettably, if not signed soon, your extensions will be delisted and will no longer appear on the site nor be available via the API. If you sign at a later date, your extensions will then be re-activated. The signing process is explained in the Wiki (steps 1 and 2).

Please also note that all extensions MUST have a license in order to be listed.

Useful links:
Eclipse Publisher Agreement
Eclipse Foundation Open VSX Registry Frequently Asked Questions (FAQ)

More details are in these recent blog posts:
https://blogs.eclipse.org/post/brian-king/open-vsx-registry-under-new-management
https://blogs.eclipse.org/post/brian-king/new-era-open-vsx-registry

Today, there’s growing momentum around open source tools and technologies that support Visual Studio (VS) Code extensions. Leading global organizations are adopting these tools and technologies. This momentum has spurred demand for a marketplace without restrictions and limitations. Thanks for joining us on this journey as we continue to build the Open VSX community.
We look forward to continued innovation from you in 2021!

dark version looks broken in VSCode

Unfortunately the dark version leaves some UI elements like the file explorer light.
Also tabs are barely readable.
(Otherwise great theme for markdown!)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.