Update README.md

giwamoto · giwamoto · commit df2c3b39f10a · 2019-06-03T20:47:08.000-06:00
diff --git a/tutorials/markdown_syntax_highlighting/README.md b/tutorials/markdown_syntax_highlighting/README.md
@@ -1,7 +1,7 @@
 [Sebastian Raschka](http://sebastianraschka.com)  
 
 last updated: 05/28/2014
-
+test
 <hr>
 I would be happy to hear your comments and suggestions.  
 Please feel free to drop me a note via
@@ -14,7 +14,7 @@ Please feel free to drop me a note via
 <br>
 <br>
 
-In this little tutorial, I want to show you in 5 simple steps how easy it is to add code syntax highlighting to your blog articles. 
+In this little tutorial, I want to show you in 5 simple steps how easy it is to add code syntax highlighting to your blog articles.
 
 There are more sophisticated approaches using static site generators, e.g., [nikola](https://github.com/getnikola/nikola), but the focus here is to give you the brief introduction of how it generally works.
 
@@ -32,28 +32,28 @@ The two packages that we will use are
 
 - [Pygments](http://pygments.org)
 
-Just as the name suggests, Python-Markdown is the Python package that we will use for the Markdown to HTML conversion. 
+Just as the name suggests, Python-Markdown is the Python package that we will use for the Markdown to HTML conversion.
 The second library, Pygments, will be used to add the syntax highlighting to the code blocks.  
 Conveniently, both libraries can be installed via `pip`:
 
 
 	pip install markdown
-	
+
 and
 
 	pip install Pygments
 
 
 (For alternative ways to install the Python-Markdown package, please see [the
 documentation](http://pythonhosted.org/Markdown/install.html))
-	
+
 
 <br>
 <br>
 
 ##2 - Writing a Markdown document
 
-Now, let us compose a simple Markdown document including some Python code blocks in any/our favorite Markdown editor. 
+Now, let us compose a simple Markdown document including some Python code blocks in any/our favorite Markdown editor.
 
 
 --> [**some_markdown.md**](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/some_markdown.md)
@@ -79,7 +79,7 @@ explicitly. One way to do this would be:
     :::python
     print("Hello, World")
 
-or we can highlight certain lines to 
+or we can highlight certain lines to
 draw the reader's attention:
 
     :::python hl_lines="1 5"
@@ -88,7 +88,7 @@ draw the reader's attention:
     for letter in "this is a test":
         print(letter)   
     # I want to be highlighted, too!
-         
+
 </pre>  
 </div>
 
@@ -101,36 +101,36 @@ So in the case of C++, for example:
 
 	:::c++
 	#include <iostream>
- 
+
 	int main()
 	{
 	    std::cout << "Hello, world!" << std::endl;
  	   return 0;
 	}
-    
+
 
 Since the CodeHilite extension in Python-Markdown uses Pygments, every programming language that is [listed here](http://pygments.org/languages/) currently has support for syntax highlighting.
 
 
 <br>
-<br> 
- 
-## 3 - Converting the Markdown document to HTML 
- 
+<br>
+
+## 3 - Converting the Markdown document to HTML
+
 
 After we created our Markdown document, we are going to use Python-Markdown directly from the command line to convert it into an HTML document.
- 
+
 Note that we can also import Python-Markdown as a module in our Python scripts, and it comes with a rich repertory of different functions, which are [listed in the library reference](https://pythonhosted.org/Markdown/reference.html).  
- 
+
 The basic command line usage to convert a Markdown document into HTML would be:
 
 	python -m markdown input.md > output.html
-	
+
 However, since we want to have syntax highlighting for our Python code, we will use Python-Markdown's [CodeHilite extension](http://pythonhosted.org/Markdown/extensions/code_hilite.html) by providing an additional `-x codehilite` argument on the command line:  
 
 
 	python -m markdown -x codehilite some_markdown.md > body.html
- 
+
 This will create the HTML body with our Markdown code converted to HTML with the Python code blocks annotated for the syntax highlighting.
 
 
@@ -144,20 +144,20 @@ If we open the [**body.html**](https://github.com/rasbt/python_reference/blob/ma
 ![](./images/mk_syntax_body_html.png)
 
 What is missing is the CSS code for adding the colors to our annotated Python code block. But we can simply create such a CSS file via `Pygments` from the command line.
- 
+
 	pygmentize -S default -f html > codehilite.css  
-	
+
 Note that we usually only need to create the [**codehilite.css**](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/codehilite.css) file once and insert a link in all our HTML files that we created via Python-Markdown to get the syntax coloring
 
- 
+
+<br>
 <br>
-<br> 
- 
- 
+
+
 ## 5 - Insert into your HTML body
- 
 
-In order to include a link to the [codehilite.css](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/codehilite.css) file for syntax coloring in our converted HTML file, we have to add the following line to the header section. 
+
+In order to include a link to the [codehilite.css](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/codehilite.css) file for syntax coloring in our converted HTML file, we have to add the following line to the header section.
 
 
 
@@ -167,10 +167,10 @@ In order to include a link to the [codehilite.css](https://github.com/rasbt/pyth
 Now, we can insert the HTML body ([body.html](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/body.html)), which was created from our Markdown document, directly into our final HTML file (e.g., our blog article template).
 
 
-[**template.html**](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/template.html): 
- 
+[**template.html**](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/template.html):
+
 <code>
-	
+
 	<!DOCTYPE html>
 	<html lang="en">
 
@@ -186,7 +186,7 @@ Now, we can insert the HTML body ([body.html](https://github.com/rasbt/python_re
 	</body>
 	</html>
 
-</code> 
+</code>
 
 If we open our [**final.html**](https://github.com/rasbt/python_reference/blob/master/tutorials/markdown_syntax_highlighting/template.html) file in our web browser now, we can the pretty Python syntax highlighting.
 
@@ -205,5 +205,3 @@ If we open our [**final.html**](https://github.com/rasbt/python_reference/blob/m
 - [pygments.org](http://pygments.org)
 
 - [languages supported](http://pygments.org/languages/) by Pygments
-
-
