Skip to content

Commit

Permalink
Documentation: SphinxQuickstartTemplate.rst: add guidelines about hig…
Browse files Browse the repository at this point in the history
…hlighting

console sessions and add more highlighter names.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@170011 91177308-0d34-0410-b5e6-96231b3b80d8
  • Loading branch information
gribozavr committed Dec 12, 2012
1 parent d52a2c0 commit 8ba4880
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/SphinxQuickstartTemplate.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,14 +107,15 @@ You can make blocks of code like this:
return 0
}

For a shell session, use a ``bash`` code block:
For a shell session, use a ``console`` code block:

.. code-block:: bash
.. code-block:: console
$ echo "Goodbye cruel world!"
$ rm -rf /
If you need to show LLVM IR use the ``llvm`` code block.
If you need to show LLVM IR use the ``llvm`` code block. Code blocks of ``c``,
``c++``, ``objc``, ``bash``, ``makefile`` kinds are supported.

You can show preformatted text without any syntax highlighting like this:

Expand All @@ -136,6 +137,8 @@ You can show preformatted text without any syntax highlighting like this:
.++:..
...

One can also use a ``none`` code block to turn off highlighting.

Hopefully you won't need to be this deep
""""""""""""""""""""""""""""""""""""""""

Expand Down

0 comments on commit 8ba4880

Please sign in to comment.