Skip to content

Commit

Permalink
Release v0.1.3
Browse files Browse the repository at this point in the history 
* Add "AsciiDoc Dark" color scheme to package (enabled by default).
* Update version badge and add package message for release v0.1.3.
* Update package documentation and enable syntax highlighting via
  Rouge highlighter (Ruby).
  • Loading branch information
@tajmone
tajmone committed Feb 4, 2024
1 parent 61ed323 commit e41ab01
Show file tree
Hide file tree
Showing 9 changed files with 751 additions and 23 deletions.
2 changes: 2 additions & 0 deletions Asciidoctor.sublime-settings
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
{
"color_scheme": "AsciiDoc Dark.sublime-color-scheme",

"indent_lists": true,

// List of built-in attributes to display in completions.
Expand Down
339 changes: 339 additions & 0 deletions Color-Schemes/AsciiDoc Dark.sublime-color-scheme
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,339 @@
// *****************************************************************************
// * *
// * AsciiDoc Dark v0.1.0 (2024/02/04) *
// * *
// *****************************************************************************
{
"name": "AsciiDoc Dark",
"author": "Tristano Ajmone",
"variables":
{
"black": "#090b0c", // Almost black

"shade2": "#1b2024", // Even darker
"shade1": "#2d353c", // Darker
"base_hue": "#3f4a54", // Base color
"tint1": "#4b5864", // Less dark
"tint2": "#566573", // Even less less dark

"tint3": "#b1d0ec", // Midtone (complement 2 of 'base_hue')
"tint4": "#d3e4f4", // between 'tint3' and 'white'
"white": "#f5f9fd", // Almost white
"grey": "#b4b9be", // (matching Grey of 'tint3')
"grey2": "#8d949b", // darker grey (blend 2/4 of 'grey' with 'base_hue')

"blue": "#5396d1", // Blue
"green": "#60cf55", // Green
"orange": "#ffa125", // Orange
"purple": "#9e5aca", // Purple
"red": "#ff2525", // Red
"yellow": "#ffff25", // Yellow
},
"globals":
{
"foreground": "var(tint4)",
"background": "var(shade1)",

"caret": "var(white)",
"invisibles": "color(var(white) alpha(0.35))",
"line_highlight": "var(tint1)",

// Accents
"misspelling": "color(var(red) alpha(0.5))",
"minimap_border": "var(tint3)",
"accent": "color(var(red) alpha(0.5))",
"fold_marker": "var(yellow)",

// Gutter
"gutter": "var(shade1)",
"gutter_foreground": "var(grey2)",

// Selection
"selection": "var(tint4)",
"selection_foreground": "var(black)",
"selection_border": "var(tint3)",
"selection_border_width": "1",
"selection_corner_style": "round", // round | cut | square
"selection_corner_radius": "3.5", // (only for round or cut)
"inactive_selection": "var(grey2)",
"inactive_selection_foreground": "var(black)",

// Find
"highlight": "var(yellow)",
"find_highlight": "var(yellow)",
"find_highlight_foreground": "var(black)",

// Guides
"guide": "var(tint2)",
"active_guide": "color(var(tint3) alpha(0.6))",
"stack_guide": "color(var(tint3) alpha(0.35))",

// Brackets
"brackets_options": "underline",
"brackets_foreground": "color(var(white) alpha(0.65))",
"bracket_contents_options": "underline",
"bracket_contents_foreground": "color(var(white) alpha(0.65))",

// Tags
"tags_options": "stippled_underline",
// "tags_foreground": "var(grey)",

// Shadows
"shadow": "var(black)",
"shadow_width": "32", // max: 32
},
"rules":
[
{
// =====================================================================
// COMMENTS
// =====================================================================
"name": "Comment",
"scope": "comment",
"foreground": "var(grey2)",
"font_style": "italic"
},
// =====================================================================
// MISC PUNCTUATION
// =====================================================================
{
"name": "Line-Breaks & List Continuations",
"scope": "constant.linebreak | constant.listcontinuation",
"foreground": "red",
},
// =====================================================================
// HORIZIONTAL RULES & PAGE-BREAKS
// =====================================================================
{
"name": "Page-Breaks",
"scope": "meta.separator.pagebreak",
"foreground": "orange",
},
{
"name": "Horizontal Rule",
"scope": "meta.separator.ruler",
"foreground": "orange",
"foreground": "orange",
},
// =====================================================================
// TEXT FORMATTING
// =====================================================================
{
"name": "Delimiters",
"scope": "punctuation.definition -punctuation.definition.comment",
"foreground": "red",
},
{
"name": "Bold",
"scope": "markup.bold",
"foreground": "orange",
"font_style": "bold",
},
{
"name": "Italic",
"scope": "markup.italic",
"foreground": "yellow",
"font_style": "italic",
},
{
"name": "Monospace",
"scope": "string.other.literal",
"background": "gainsboro",
"foreground": "black",
},
{
"name": "Monospace: Delimiter",
"scope": "punctuation.definition.literal",
"background": "color(gainsboro alpha(0.8))",
"font_style": "bold",
},
{
"name": "Mark",
"scope": "string.other.unquoted",
"background": "#ccff00",
"foreground": "black",
},
{
"name": "Mark: Delimiter",
"scope": "punctuation.definition.string.unquoted",
"font_style": "bold",
},
// =====================================================================
// PASSTHROUGH INLINE
// =====================================================================
{
"name": "Passthrough: Delimiter",
"scope": "constant.character.passthrough",
"foreground": "red",
},
{
"name": "Passthrough: Contents",
"scope": "variable.parameter.passthroughinner",
"foreground": "var(shade1)",
},
{
"name": "Passthrough: All",
"scope": "meta.passthrough.inline",
"background": "var(tint4)",
},
// =====================================================================
// ATTRIBUTES
// =====================================================================
{
"name": "Attribute Definition: Identifier",
"scope": "support.variable.attribute",
"foreground": "dodgerblue",
},
{
"name": "Attribute Definition: Delimiter",
"scope": "punctuation.definition.attributeentry.attrname",
"foreground": "red",
},
{
"name": "Attribute Definition: Unset",
"scope": "punctuation.definition.attributeentry.unset",
"foreground": "yellow",
},
{
"name": "Attribute Definition: Value",
"scope": "meta.attributeentry.value",
"foreground": "orange",
},
// =====================================================================
// BLOCK ID
// =====================================================================
{
"name": "Block ID",
"scope": "markup.underline.blockid.id",
"foreground": "dodgerblue",
},
// =====================================================================
// BLOCK TITLE
// =====================================================================
{
"name": "Block Title",
"scope": "markup.heading.block",
"foreground": "dodgerblue",
},
// =====================================================================
// BLOCKS
// =====================================================================
{
"name": "Block Delimiters",
"scope": "constant.delimiter",
"foreground": "red",
},
{
"name": "Fallback Blocks",
"scope": "constant.delimiter | string.literal.block",
"background": "darkslategray",
},
{
"name": "Fallback Blocks: Delimiter",
"scope": "constant.delimiter",
"background": "color(darkslategray alpha(0.4))",
},
// EXAMPLE BLOCK
{
"name": "Example",
"scope": "constant.delimiter.example | string.unquoted.block.example",
"background": "color(var(yellow) alpha(0.1))",
},
// SOURCE CODE BLOCK
{
"name": "Source Code",
"scope": "constant.delimiter.listing | source.block.listing",
"background": "gainsboro",
"foreground": "black",
},
{
"name": "Source Code: Delimiter",
"scope": "constant.delimiter.listing",
"background": "color(gainsboro alpha(0.9))",
"foreground": "red",
},

// =====================================================================
// SECTION TITLES
// =====================================================================
{
"name": "Section Titles",
"scope": "markup.heading.level",
"background": "dodgerblue",
"font_style": "bold",
},
{
"name": "Section Titles: Delimiter",
"scope": "punctuation.definition.heading",
"foreground": "white",
"foreground": "transparent",
"foreground": "var(shade1)",
},
{
"name": "Section Titles: Text",
"scope": "entity.name.section.asciidoc",
"font_style": "bold",
"foreground": "white",
},
// =====================================================================
// INVALID
// =====================================================================
{
"name": "Invalid",
"scope": "invalid",
"foreground": "var(white)",
"background": "var(red)",
},
{
"scope": "message.error",
"foreground": "color(var(red) alpha(0.5))",
},
// =====================================================================
// CONSTANTS
// =====================================================================
{
"scope": "constant.character.escape",
"foreground": "var(purple)",
},
// Bibliographic Anchors
{
"scope": "storage.type.reference.biblioanchor",
"foreground": "var(purple)",
},
{
"scope": "constant.character.entity",
"foreground": "var(orange)",
},
// Callouts
{
"scope": "punctuation.definition.calloutlistnumber",
"foreground": "var(red)",
},
{
"scope": "constant.numeric.callout",
"foreground": "var(yellow)",
},
// Admonitions
{
"scope": "support.constant.admonitionword",
"foreground": "var(orange)",
},
// X-Refs
{
"scope": "meta.xref",
"foreground": "color(var(red) lightness(70%))",
},
{
"scope": "constant.character.xref.(begin|end)",
"foreground": "color(var(red) lightness(70%))",
},
{
"scope": "variable.parameter.xref.link",
"foreground": "color(var(purple) lightness(70%))",
},
{
"scope": "variable.parameter.xref.display",
"foreground": "var(tint4)",
},
]
}
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ THE SOFTWARE.

<!-- badges -->

[Package badge]: https://img.shields.io/badge/version-0.1.2-orange "ST4-Asciidoctor is currently in Alpha stage"
[Package badge]: https://img.shields.io/badge/version-0.1.3-orange "ST4-Asciidoctor is currently in Alpha stage"
[Travis badge]: https://app.travis-ci.com/tajmone/ST4-Asciidoctor.svg?branch=master "Travis CI: EditorConfig validation status"
[Travis link]: https://app.travis-ci.com/github/tajmone/ST4-Asciidoctor
[ST badge]: https://img.shields.io/badge/Sublime_Text-4168-yellow?logo=sublime-text&logoColor=FF9800 "Sublime Text version used in development (click to visit download page)"
Expand Down
2 changes: 2 additions & 0 deletions Rakefile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ GUIDE_DEPS = FileList[
]

GUIDE_ADOC_OPTS = <<~HEREDOC
-a source-highlighter=rouge \
-a rouge-style=thankful_eyes \
--failure-level WARN \
--verbose \
--timings \
Expand Down
21 changes: 19 additions & 2 deletions docs-src/features.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
= Package Features
// The kbd:[] macros won't work unless the experimental attribute is turned on.
:experimental: true

:Y: Yes
:N: No

Expand All @@ -16,6 +15,24 @@ The following file extensions are automatically recognized as AsciiDoc files:
* `.asciidoc`


== Color Schemes

The package ships with a dedicated color scheme (AsciiDoc Dark) which is enable by default in `Asciidoctor.sublime-settings`:

[source,json]
-------------------------------------------------------
{
"color_scheme": "AsciiDoc Dark.sublime-color-scheme",
-------------------------------------------------------

You can always override this setting and enforce a color scheme of your choice by creating your own `Asciidoctor.sublime-settings` in the `Packages/User` directory.

The reason I'm currently enforcing the package default scheme is because the package is still under development, and this color scheme reflects the overall direction of my efforts in term of what I believe should be visually highlighted while working with the AsciiDoc syntax.
Therefore, I would like all collaborators to the project to appreciate the native package scheme and its "`flavor,`" so to speak.

Many elements of the AsciiDoc syntax rely on scopes names which are peculiar to AsciiDoc, and very unlikely to be covered by general purpose color schemes designed for programming languages or lightweight markup syntaxes (like Markdown, reST, etc.).


== Snippets

The following table lists the package snippets and their features.
Expand Down
Loading

0 comments on commit e41ab01

Please sign in to comment.