hubdown 0.0.3 → 0.0.4
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.
- data/README.md +8 -8
- data/bin/hubdown +0 -1
- data/lib/hubdown/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
@@ -15,8 +15,8 @@ $ gem install hubdown
|
|
15
15
|
There are essentially 3 options when using `hubdown`.
|
16
16
|
|
17
17
|
* Printing to STDOUT
|
18
|
-
*
|
19
|
-
*
|
18
|
+
* Wrap in Github HTML
|
19
|
+
* Output to a file
|
20
20
|
|
21
21
|
***
|
22
22
|
### Printing to STDOUT
|
@@ -29,21 +29,21 @@ $ hubdown my_file.md
|
|
29
29
|
|
30
30
|
Doing so will send converted markdown to standard output allowing you to pipe the file as you wish.
|
31
31
|
***
|
32
|
-
###
|
32
|
+
### Wrap in Github HTML
|
33
33
|
|
34
34
|
```bash
|
35
|
-
$ hubdown
|
35
|
+
$ hubdown file.md -w
|
36
36
|
```
|
37
37
|
|
38
|
-
When passing the `-
|
38
|
+
When passing the `-w` flag hubdown will render the markdown in an approximation of what Github provides and push it to STDOUT.
|
39
39
|
***
|
40
|
-
###
|
40
|
+
### Output to a file
|
41
41
|
|
42
42
|
```bash
|
43
|
-
$ hubdown
|
43
|
+
$ hubdown my_file.md -o my_file.html
|
44
44
|
```
|
45
45
|
|
46
|
-
When passing the `-
|
46
|
+
When passing the `-o` flag with a file name, hubdown will write the full html output (as though you passed the `-w`) to the file you pass with `-o`.
|
47
47
|
***
|
48
48
|
|
49
49
|
## Contributing
|
data/bin/hubdown
CHANGED
data/lib/hubdown/version.rb
CHANGED