Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update readme

  • Loading branch information...
commit 4cf7795435d11af61435b7613c88f84e6d9ee9ec 1 parent f3f6d69
@crdx authored
Showing with 6 additions and 5 deletions.
  1. +6 −5 README.md
View
11 README.md
@@ -16,13 +16,12 @@ You can install the package and its dependencies using `npm`.
## Usage
- Usage: markdowns [-h] [-v] [-w] [-p] [-V] [-d] [-e EXTENSION] [-f] [directory]
+ Usage: markdowns [-h] [-v] [-w] [-p] [-V] [-d] [-e EXTENSION] [-f] [-n ENCODING] [directory]
Watches and converts Markdown files into HTML files.
Positional arguments:
- directory The directory to process or watch. Defaults to the
- current directory.
+ directory The directory to process or watch. Defaults to the current directory.
Optional arguments:
-h, --help Show this help message and exit.
@@ -32,9 +31,11 @@ You can install the package and its dependencies using `npm`.
-V, --verbose Be verbose.
-d, --debug Show debugging output.
-e EXTENSION, --extension EXTENSION
- Set the file extension of Markdown files.
+ Set the file extension of Markdown files. Defaults to md.
-f, --force Ignore warnings.
-
+ -n ENCODING, --encoding ENCODING
+ Set the file encoding of the output files (ascii or utf8). Defaults to utf8.
+
If invoked with the `-p` or `--process` argument, **markdowns** will perform a one-time pass over the Markdown files in the directory, converting each one to HTML.
If invoked with the `-w` or `--watch` argument, **markdowns** will continuously watch all the Markdown files in the directory for changes, and convert any in which a change is detected.
Please sign in to comment.
Something went wrong with that request. Please try again.