Changeset 597693

Timestamp:

09/11/2012 07:49:39 PM (12 years ago)

Author:

dougal

Message:

Convert README.md to GitHub-flavor

File:

• documents-shortcode/trunk/README.md (modified) (9 diffs)

documents-shortcode/trunk/README.md

@@ -1 @@
-=== Documents Shortcode ===
+# Documents Shortcode
 Contributors: dougal
 Donate link: http://dougal.gunters.org/donate
@@ -11 +11 @@
 A `[documents]` shortcode which will display a list of attached files, with file type icons, and linked to the files for easy downloading.
 
-== Description ==
+## Description
 
 By adding a simple `[documents]` shortcode in your post or page, you get a
@@ -18 +18 @@
 based on file extension (e.g., .doc, .pdf, etc).
 
-== Installation ==
+## Installation
 
 Copy the documents-shortcode folder and its contents to your wp-content/plugins
@@ -27 +27 @@
 posts or pages to generate a list of attached files.
 
-== Frequently Asked Questions ==
+## Frequently Asked Questions
 
-= Where is the settings page? =
+### Where is the settings page?
 
 There is no settings page. Just upload attachments to a post or page, and put 
 the `[documents]` shortcode where you wish the list of attachments to appear.
 
-= How can I limit which attachments are listed? =
+### How can I limit which attachments are listed?
 
 There are two attributes you can use with the shortcode to control which
@@ -59 +59 @@
       `[documents mimetype="*"]`
 
-= I got an error trying to upload a file! =
+### I got an error trying to upload a file!
 
 If WordPress tells you that a file failed to upload due to an error ("Sorry, 
@@ -70 +70 @@
     http://www.wprecipes.com/wordpress-tip-allow-upload-of-more-file-types
 
-= How do I change the styling? =
+### How do I change the styling?
 
 See the `dc_documents.css` file for the default styles. Document icons are in 
@@ -81 +81 @@
     `.post ul.dc_documents li a { font-family: Courier,monospace; }`
 
-= Why don't my attached images appear in the documents list? =
+### Why don't my attached images appear in the documents list?
 
 By default, images are filtered out of the list (because, that's what 
@@ -89 +89 @@
     `[documents mimetype="*"]`
 
-= What file types are supported? =
+### What file types are supported?
 
 *Technically*, any file type that WordPress will allow you to upload as an 
@@ -108 +108 @@
 future, and I am open to suggestions.
 
-= Can you make the icon bigger/smaller? =
+### Can you make the icon bigger/smaller?
 
 At this time, the only supported icon size is 32 x 32 pixels. 
 
-== Changelog ==
-= 1.0 =
+## Changelog
+### 1.0
 * Initial release. 2012-09-10