lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From no...@apache.org
Subject [01/50] [abbrv] lucene-solr:feature/autoscaling: Ref Guide: Update meta-doc info on lexers for source blocks
Date Tue, 03 Oct 2017 13:38:42 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/feature/autoscaling 942b6715b -> 2c873cd8c


Ref Guide: Update meta-doc info on lexers for source blocks


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/feec5c6f
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/feec5c6f
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/feec5c6f

Branch: refs/heads/feature/autoscaling
Commit: feec5c6f091433651046439fe079000126606b3b
Parents: 1b88435
Author: Cassandra Targett <ctargett@apache.org>
Authored: Mon Sep 25 13:14:31 2017 -0500
Committer: Cassandra Targett <ctargett@apache.org>
Committed: Mon Sep 25 13:14:31 2017 -0500

----------------------------------------------------------------------
 solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc | 8 ++++++++
 1 file changed, 8 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/feec5c6f/solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc b/solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc
index e0e5aec..05a7421 100644
--- a/solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc
+++ b/solr/solr-ref-guide/src/meta-docs/asciidoc-syntax.adoc
@@ -64,6 +64,14 @@ If your code block will include line breaks, put 4 hyphens (`----`) before
and a
 
 More info: http://asciidoctor.org/docs/user-manual/#source-code-blocks
 
+==== Source Block Syntax Highlighting
+
+The PDF and HTML outputs use Pygments to add syntax highlighting to code examples. This is
done by adding the language of the code block after the `source`, as shown in the above example
source block (`xml` in that case).
+
+Pygments has a long selection of lexers available. You can see the full list at http://pygments.org/docs/lexers.
Use one of the valid short names to get syntax highlighting for that language.
+
+Ideally, we will have an appropriate lexer to use for all source blocks, but that's not possible.
When in doubt, choose `text`, or leave it blank.
+
 === Block Titles
 
 Titles can be added to most blocks (images, source blocks, tables, etc.) by simply prefacing
the title with a period (`.`). For example, to add a title to the source block example above:


Mime
View raw message