-
Notifications
You must be signed in to change notification settings - Fork 2
/
readme.txt
49 lines (32 loc) · 2.18 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
=== Remote Markdown for WordPress ===
Contributors: andrezrv
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=B7XQG5ZA36UZ4
Tags: github, bitbucket, markdown, remote, parse, syntax
Requires at least: 3.0
Tested up to: 4.2.3
Stable tag: 1.1
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Include contents in your WordPress posts and pages from a remote markdown-formatted file.
== Description ==
This plugin adds a shortcode that allows to include contents in your posts and pages from a remote markdown-formatted file. It supports Github Flavored Markdown and is meant to synchronize your app documentation from your GitHub or Bitbucket repo to your website, without having the need to update both.
### Usage
`
[remote-markdown refresh="60"]https://raw.githubusercontent.com/andrezrv/wp-remote-markdown/master/README.md[/remote-markdown]
`
Use `crayon="1"` to activate compatibility with the Crayon Syntax Highlighter plugin, if you have it installed.
Once loaded for the first time, a [transient](http://codex.wordpress.org/Transients_API) will be created with the expiration (in seconds) specified in the `refresh` property. That will prevent your site from doing a lot of unnecessary requests while the remote file is not being updated. A value of zero, or not using the parameter, will prevent the creation of the transient.
### Contribute
You can make suggestions and submit your own modifications to this plugin on [Github](https://github.com/andrezrv/wp-remote-markdown).
### Credit Where Credit is Due
This plugin makes use of the Emanuil Rusev's [Parsedown](https://github.com/erusev/parsedown) PHP library for Markdown parsing, and [Google Code Prettify]((https://code.google.com/p/google-code-prettify/)) for language syntax highlighting.
== Installation ==
1. Unzip `wp-remote-markdown.zip` and upload the `wp-remote-markdown` folder to your `/wp-content/plugins/` directory.
2. Activate the plugin through the **"Plugins"** menu in WordPress.
== Changelog ==
= 1.1 =
Added compatibility with Crayon Syntax Highlighter plugin.
= 1.0.1 =
Added Google Code Prettify source code to prevent external dependencies.
= 1.0 =
First public release.