Skip to content

Commit

Permalink
Merge pull request #17 from neocotic/wip-2.0.2
Browse files Browse the repository at this point in the history
WIP 2.0.2
  • Loading branch information
neocotic committed Feb 4, 2013
2 parents 30271ee + dde8a87 commit 6a02f8c
Show file tree
Hide file tree
Showing 9 changed files with 124 additions and 16 deletions.
5 changes: 5 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## 2013.02.04, Version 2.0.2

* [#13](https://github.com/neocotic/html.md/issues/13): Add new man page
* [#14](https://github.com/neocotic/html.md/issues/14): Fix bug with `eval` option

## 2012.12.12, Version 2.0.1

* [#8](https://github.com/neocotic/html.md/issues/8): Fix incorrect version
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2012 Alasdair Mercer, http://neocotic.com/
Copyright (C) 2013 Alasdair Mercer, http://neocotic.com/

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion bin/md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ parseHtml = (file, input, base) ->
output = md input, opts
if opts.print
console.log output
else
else if file
writeMarkdown file, output, base
catch err
exit 1, err instanceof Error and err.stack or "ERROR: #{err}"
Expand Down
6 changes: 3 additions & 3 deletions dist/md.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

102 changes: 102 additions & 0 deletions docs/md.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
.TH MD 1 "February 2013" "" "General Commands Manual"

.SH NAME
.B md
\- HTML to Markdown converter

.SH SYNOPSIS

.B md
[
.B \-adlp
]
[
.B \-o
.I output_dir
]
[
.I paths
]
.br
[
.B \-dp
]
[
.B \-e
.I html
]
.br
[
.B \-v
]

.SH DESCRIPTION

html.md is a JavaScript library which allows HTML to be
converted into valid Markdown. It also supports file
systems to provide a complete command line utility.

.SH OPTIONS

.TP 15
.B \-a/\-\-absolute
Always use absolute URLs for converted links.

.TP
.B \-d/\-\-debug
Debug mode. Causes
.B md
to print debugging messages about its progress.

.HP
.B \-e/\-\-eval
.I html
.br
Specifies the HTML string to be evaluated.

.TP
.B \-l/\-\-long-ext
Generated Markdown files should have the long file
extension. When used, files will be created in the
.I output_dir
will have a .markdown file extension.

.HP
.B \-o/\-\-output
.I output_dir
.br
Specifies the output directory to which generated
Markdown files will be created.

.TP
.B \-p/\-\-print
Print out converted Markdown to the
.B stdout
stream.

.TP
.B \-v/\-\-version
Display the version number and exit.

.SH BUGS

Inline HTML is not yet supported in the resulting
Markdown.

.SH CAVEATS

It is always recommended to pair option
.B \-p
with
.B \-e
otherwise
.B md
does all of the work but you won't see the outcome.

.SH AUTHOR

Alasdair Mercer <
.I [email protected]
> (
.I http://neocotic.com
)
Loading

0 comments on commit 6a02f8c

Please sign in to comment.