Browse Source

Update README.md

Fix rendering of headers
winlu 6 years ago
parent
commit
602b38c19d
1 changed files with 10 additions and 10 deletions
  1. 10 10
      gallery/README.md

+ 10 - 10
gallery/README.md

@@ -4,7 +4,7 @@ Gallery
 * Allows an article to contain an album of pictures.
 * All albums can also be syndicated into a central gallery page.
 
-##How to Use
+## How to Use
 
 1. Group images into folders, with each folder representing an album.
 2. Place all album folders within a folder, which should reside under content.
@@ -12,7 +12,7 @@ Gallery
 
 		./content/images/gallery/{your albums}
 	
-###Articles
+### Articles
 
 Attach an album to an article/post by placing a gallery metadata tag with the name of the album.
 
@@ -26,7 +26,7 @@ And the filename of images within an album.
 
 	article.albumimages
 
-###Gallery Page
+### Gallery Page
 
 Create a page and a gallery template (named gallery.html). And inform pelican to use the gallery template for the page.
 
@@ -37,9 +37,9 @@ The dictionary key is the name of the album and the lists contain the filenames.
 
 	page.gallery
 	
-##Examples
+## Examples
 
-###article.html
+### article.html
 
 	<h2><a href="{{ SITEURL }}/pages/gallery.html#{{ article.album }}">{{ article.album }}</a></h2>
 	    <ul>
@@ -48,7 +48,7 @@ The dictionary key is the name of the album and the lists contain the filenames.
 		{% endfor %}
 	    </ul>
 		
-###gallery.html
+### gallery.html
 
 	{% for album, images in page.gallery.iteritems() %}
 	<h2><a name="{{ album }}">{{ album }}</a></h2>
@@ -59,17 +59,17 @@ The dictionary key is the name of the album and the lists contain the filenames.
 	</ul>
 	{% endfor %}
 
-###posts/foo.md
+### posts/foo.md
 
 	title:Foo
 	gallery:albumname
 	
-###pages/gallery.md
+### pages/gallery.md
 
 	title:All Images
 	template:gallery
 	
-##Reasoning
+## Reasoning
 
 The album name and filenames are returned as opposed to the direct path to the images,
 to allow flexibility of different thumbnail sizes to be used it different locations of a website.
@@ -80,7 +80,7 @@ to allow flexibility of different thumbnail sizes to be used it different locati
 It also allows a thumbnail to link to the full image,
 as well as the filename extension to be stripped and the title of an image to be displayed along side the title of an album.
 
-##Recommendation
+## Recommendation
 
 It is recommended to use this extension along with the thumbnailer plugin.