razorheadfx / grup Goto Github PK

Currently these deps are tracking pre-release branches because of an issue described in: e7376d9

hyper           = "0.13.0-alpha.4"
tokio-fs        = "0.2.0-alpha.6"
tokio-io        = "0.2.0-alpha.6"
tokio-sync      = "0.2.0-alpha.6"
tokio           = { version = "=0.2.0-alpha.6" }

Once the std::future friendly versions of the deps have dropped, bump them to minor versions.

Also once notify has a stable 5.xrelease bump to major version

As discussed in #1

TODO:

• Implement serving directory containing the .md file and subdirectories
• Add flag enabling this behaviour
• Add whitelisting for image files
• Update README to include @NickeZ as contributor

Add a render mode that directly outputs the markdown as html with stylesheet included in the header.

For example

grup README.md --offline readme.html

That way one could use the awesome wkhtmltopdf cli tool to directly output a rendered pdf file from a .md file, like so:

 grup README.md --offline readme.html && wkhtmltopdf readme.html readme.pdf && rm readme.html

Right now there is just a markdown parsing step and the content being dumped to html.
Thus umlauts (and other unicode chars) break in the usual html way.

Potential Fixes:
Might be sufficient to set the charset to utf-8. (c.f. https://en.wikipedia.org/wiki/Unicode_and_HTML#Character_encoding_determination).

Content-Type: text/html; charset=UTF-8

Assumes:

• All users use utf-8 in the first place (seems reasonable enough at this point).

Currently running something like the following will cause an error on windows

# for example mdfile D:\test\md\md.md and pwd=D:\test\md\
$ grup md.md

yields:

Error: Os { code: 123, kind: Other, message: "The filename, directory name, or volume label syntax is incorrect." }

Running with

 # for example mdfile D:\test\md\md.md and pwd=D:\test
$ grup test\md.md

yields:

Error: Custom { kind: Other, error: "No such file: \"md\\\\md.md\"" }

This can currently be fixed by prepending .\ (i.e. .\md.md when in the same directory) so windows finds the file correctly.

This also does not bode well for the static file functionality.

Commit 11d53ba removed license from Cargo.toml in favor of license-file, but this causes crates.io to show it as a "non-standard" license. I would recommend going the other way, using only the license field, but do make sure the file is still included in the package (cargo package --list).

See also: rust-lang/cargo#8537