markdown_helper 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +6 -6
- data/lib/markdown_helper/version.rb +1 -1
- data/readme/README.template.md +6 -6
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ccb80bcecf1c22af77afe2d8e9e8038fa3859fdd
|
4
|
+
data.tar.gz: 38849d0c824346ecb21402249e542079752e0b51
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7c7ad470f6d1927e95ee82c3e1a2a726a14bed010c3a0e42a873eb2e306377a199775dd9b9e8f717e33f11b127a52d0aa6a12b5994c238bd5698e02b108bc392
|
7
|
+
data.tar.gz: 026bc9fa396418b313f7e4b788ab0ef9fe0e06e3b7eb81d75e849fb44eae6eccda9d1d728afb55a44d94af636d57dbb2160262baf630207e8274dea0d2c20578
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -6,7 +6,7 @@ This markdown helper enables file inclusion in GitHub markdown.
|
|
6
6
|
|
7
7
|
(Actually this README file is built using the file inclusion.)
|
8
8
|
|
9
|
-
You can use it to merge external files into a markdown (
|
9
|
+
You can use it to merge external files into a markdown (</code>.md</code>) file.
|
10
10
|
|
11
11
|
The merged text can be highlighted in a code block:
|
12
12
|
|
@@ -49,18 +49,18 @@ or verbatim (which GitHub renders however it likes).
|
|
49
49
|
|
50
50
|
An inclusion pragma has the form:
|
51
51
|
|
52
|
-
|
52
|
+
<code>@[</code>*treatment*<code>](</code>*relative_file_path*<code>)</code>
|
53
53
|
|
54
54
|
where:
|
55
55
|
|
56
56
|
* *treatment* (in square brackets) is one of the following:
|
57
|
-
* Highlighting mode such as
|
58
|
-
*
|
59
|
-
*
|
57
|
+
* Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block. This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
58
|
+
* <code>[:code_block]</code>, to include a plain code block.
|
59
|
+
* <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
|
60
60
|
* *relative_file_path* points to the file to be included.
|
61
61
|
|
62
62
|
|
63
|
-
#### Include the Files with
|
63
|
+
#### Include the Files with <code>MarkdownHelper#include</code>
|
64
64
|
|
65
65
|
<code>usage.rb</code>
|
66
66
|
```ruby
|
data/readme/README.template.md
CHANGED
@@ -6,7 +6,7 @@ This markdown helper enables file inclusion in GitHub markdown.
|
|
6
6
|
|
7
7
|
(Actually this README file is built using the file inclusion.)
|
8
8
|
|
9
|
-
You can use it to merge external files into a markdown (
|
9
|
+
You can use it to merge external files into a markdown (</code>.md</code>) file.
|
10
10
|
|
11
11
|
The merged text can be highlighted in a code block:
|
12
12
|
|
@@ -28,17 +28,17 @@ or verbatim (which GitHub renders however it likes).
|
|
28
28
|
|
29
29
|
An inclusion pragma has the form:
|
30
30
|
|
31
|
-
|
31
|
+
<code>@[</code>*treatment*<code>](</code>*relative_file_path*<code>)</code>
|
32
32
|
|
33
33
|
where:
|
34
34
|
|
35
35
|
* *treatment* (in square brackets) is one of the following:
|
36
|
-
* Highlighting mode such as
|
37
|
-
*
|
38
|
-
*
|
36
|
+
* Highlighting mode such as <code>[ruby]</code>, to include a highlighted code block. This can be any Ace mode mentioned in [GitHub Languages](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
37
|
+
* <code>[:code_block]</code>, to include a plain code block.
|
38
|
+
* <code>[:verbatim]</code>, to include text verbatim (to be rendered as markdown).
|
39
39
|
* *relative_file_path* points to the file to be included.
|
40
40
|
|
41
41
|
|
42
|
-
#### Include the Files with
|
42
|
+
#### Include the Files with <code>MarkdownHelper#include</code>
|
43
43
|
|
44
44
|
@[ruby](usage.rb)
|