From f4f9af06c9e6f468d9f696dbb5438dd8825fe773 Mon Sep 17 00:00:00 2001 From: Horacio Sanson Date: Tue, 29 Nov 2016 13:18:13 +0900 Subject: [PATCH] Enable display of admonition icons in Asciidoc. When rendering Asciidoc documents this merge request enables the diplay of admonition blocks using font icons. This improves the looks of Asciidoc redered files. This uses the font-awesome fonts already present in Gitlab so no large dependencies are required for this to work. --- app/assets/stylesheets/framework.scss | 1 + .../stylesheets/framework/asciidoctor.scss | 27 +++++++++++++++++++ .../enable-asciidoctor-admonition-icons.yml | 4 +++ lib/gitlab/asciidoc.rb | 2 +- 4 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 app/assets/stylesheets/framework/asciidoctor.scss create mode 100644 changelogs/unreleased/enable-asciidoctor-admonition-icons.yml diff --git a/app/assets/stylesheets/framework.scss b/app/assets/stylesheets/framework.scss index 4d4835568ed..c82a9a2b9e3 100644 --- a/app/assets/stylesheets/framework.scss +++ b/app/assets/stylesheets/framework.scss @@ -6,6 +6,7 @@ @import "framework/animations.scss"; @import "framework/avatar.scss"; +@import "framework/asciidoctor.scss"; @import "framework/blocks.scss"; @import "framework/buttons.scss"; @import "framework/calendar.scss"; diff --git a/app/assets/stylesheets/framework/asciidoctor.scss b/app/assets/stylesheets/framework/asciidoctor.scss new file mode 100644 index 00000000000..62493c32833 --- /dev/null +++ b/app/assets/stylesheets/framework/asciidoctor.scss @@ -0,0 +1,27 @@ +.admonitionblock td.icon { + width: 1%; + + [class^="fa icon-"] { + @extend .fa-2x; + } + + .icon-note { + @extend .fa-thumb-tack; + } + + .icon-tip { + @extend .fa-lightbulb-o; + } + + .icon-warning { + @extend .fa-exclamation-triangle; + } + + .icon-caution { + @extend .fa-fire; + } + + .icon-important { + @extend .fa-exclamation-circle; + } +} diff --git a/changelogs/unreleased/enable-asciidoctor-admonition-icons.yml b/changelogs/unreleased/enable-asciidoctor-admonition-icons.yml new file mode 100644 index 00000000000..9c52e53c3b4 --- /dev/null +++ b/changelogs/unreleased/enable-asciidoctor-admonition-icons.yml @@ -0,0 +1,4 @@ +--- +title: Enable AsciiDoctor admonition icons +merge_request: 7812 +author: Horacio Sanson diff --git a/lib/gitlab/asciidoc.rb b/lib/gitlab/asciidoc.rb index 1a22ad9acf5..9667df4ffb8 100644 --- a/lib/gitlab/asciidoc.rb +++ b/lib/gitlab/asciidoc.rb @@ -6,7 +6,7 @@ module Gitlab module Asciidoc DEFAULT_ADOC_ATTRS = [ 'showtitle', 'idprefix=user-content-', 'idseparator=-', 'env=gitlab', - 'env-gitlab', 'source-highlighter=html-pipeline' + 'env-gitlab', 'source-highlighter=html-pipeline', 'icons=font' ].freeze # Public: Converts the provided Asciidoc markup into HTML.