diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,132 @@ +## [0.6.7] - 2015-06-02 + +### Added + +* Support for pandoc greater than version 1.14 + +## [0.6.6] - 2014-09-24 + +### Changed + +* Dependencies to be up to date + +## [0.6.5] - 2013-05-14 + +### Fixed + +* Links to section IDs in parallel layout +* Exclusion of shebangs within files + +## [0.6.4] - 2013-05-11 + +### Fixed + +* Data directory searching with the cabal package + +## [0.6.3] - 2013-05-09 + +### Fixed + +* Title headers when left empty + +## [0.6.2] - 2013-05-07 + +### Changed + +* Use of `Map` to `HashMap` +* Store language definitions in a separate JSON file + +## [0.6.1] - 2013-05-06 + +### Fixed + +* Multiple CSS inclusions in template files + +### Removed + +* Explicit normalize.css file in linear template + +## [0.6.0] - 2013-05-05 + +### Added + +* cmdags for command line argument parsing +* Help flag in CLI +* Version flag in CLI +* Error message when no files are put into the CLI +* More than one template -- linear and parallel + +### Changed + +* Headers, both h1 and h2, are on their own separate line +* Recursive directory to include subdirectory as well + +## [0.5.0] - 2013-04-30 + +### Added + +* Support for Literate Haskell + +### Changed + +* Code highlight from pygments to highlighting-kate + +## [0.4.0] - 2013-04-26 + +### Added + +* Support for pandoc greater than version 1.10 +* Support for unicode characters + +### Changed + +* Functions using `ByteString` to `Text` + +## [0.3.0] - 2012-04-03 + +### Fixed + +* Function name typo `ensurePar` to `ensurePair` + +### Changed + +* Functions using `String` to `ByteString` + +## [0.2.0] - 2011-10-26 + +### Added + +* Language support for CoffeeScript +* Language support for JavaScript +* Language support for Python +* Language support for Ruby +* LICENSE file under the MIT license +* Recursive directory search + +### Fixed + +* Non-exhausive pattern compiler warning +* A case where some codes lines would be marked as comments + +## 0.1.0 - 2011-09-25 + +### Added + +* Translation of functions from Docco to Haskell function +* Implementation of function from Markdown to HTML +* Haskell comment documentation generation +* Highlighting code blocks with pygments +* Parser to separate out prose from code + +[0.6.7]: https://github.com/sourrust/hyakko/compare/v0.6.6...v0.6.7 +[0.6.6]: https://github.com/sourrust/hyakko/compare/v0.6.5...v0.6.6 +[0.6.5]: https://github.com/sourrust/hyakko/compare/v0.6.4...v0.6.5 +[0.6.4]: https://github.com/sourrust/hyakko/compare/v0.6.3...v0.6.4 +[0.6.3]: https://github.com/sourrust/hyakko/compare/v0.6.2...v0.6.3 +[0.6.2]: https://github.com/sourrust/hyakko/compare/v0.6.1...v0.6.2 +[0.6.1]: https://github.com/sourrust/hyakko/compare/v0.6.0...v0.6.1 +[0.6.0]: https://github.com/sourrust/hyakko/compare/v0.5.0...v0.6.0 +[0.5.0]: https://github.com/sourrust/hyakko/compare/v0.4.0...v0.5.0 +[0.4.0]: https://github.com/sourrust/hyakko/compare/v0.3.0...v0.4.0 +[0.3.0]: https://github.com/sourrust/hyakko/compare/v0.2.0...v0.3.0 +[0.2.0]: https://github.com/sourrust/hyakko/compare/1362ad0...v0.2.0 diff --git a/LICENSE b/LICENSE --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2013 Jeremy Hull +Copyright (c) 2015 Jeremy Hull Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,25 @@ + + + _ _ _ + | |__ _ _ __ _| | _| | _ ___ + | '_ \| | | |/ _` | |/ / |/ / _ \ + | | | | |_| | (_| | <| < (_) | + |_| |_|\__, |\__,_|_|\_\_|\_\___/ + |___/ + + + + Hyakko is a Haskell port of Docco: the original quick-and-dirty, + hundred-line-long, literate-programing-style documentation generator. + More info: + + coffeescript (original): + + Other ports + ----------- + Clojure: + Lua: + .NET: + Python: + Ruby: + Shell: diff --git a/hyakko.cabal b/hyakko.cabal --- a/hyakko.cabal +++ b/hyakko.cabal @@ -1,10 +1,10 @@ name: hyakko -version: 0.6.6 +version: 0.6.7 cabal-version: >= 1.6 build-type: Simple license: MIT license-file: LICENSE -copyright: (c) 2013 Jeremy Hull +copyright: (c) 2015 Jeremy Hull author: Jeremy Hull maintainer: Jeremy Hull bug-reports: https://github.com/sourrust/hyakko/issues @@ -50,6 +50,8 @@ resources/parallel/public/fonts/novecento-bold.ttf resources/parallel/public/fonts/novecento-bold.woff extra-source-files: + CHANGELOG.md + README src/Hyakko/Text/Markdown.hs src/Hyakko/Text/Templates.hs src/Hyakko/Types.hs @@ -63,17 +65,17 @@ Executable hyakko build-depends: base >= 4 && < 5, - filepath >= 1.2 && < 1.4, + filepath >= 1.2 && < 1.5, regex-pcre-builtin >= 0.9 && < 1.0, unordered-containers >= 0.2 && < 0.3, directory >= 1.0 && < 2.0, - pandoc == 1.13.*, + pandoc == 1.14.*, bytestring >= 0.9 && < 1.0, text >= 0.11 && < 2.0, - highlighting-kate == 0.5.*, + highlighting-kate == 0.6.*, blaze-html >= 0.5 && < 1.0, cmdargs == 0.10.*, - aeson >= 0.7 && < 0.8, + aeson >= 0.7 && < 0.10, mtl >= 2.1 && < 2.2 hs-source-dirs: src ghc-options: -O2 -Wall diff --git a/src/Hyakko/Text/Markdown.hs b/src/Hyakko/Text/Markdown.hs --- a/src/Hyakko/Text/Markdown.hs +++ b/src/Hyakko/Text/Markdown.hs @@ -1,16 +1,13 @@ module Hyakko.Text.Markdown (toHTML) where -import Text.Pandoc ( readMarkdown - , writeHtmlString - , def - ) - -import Data.Text (Text, pack) +import Data.Text (Text, pack, empty) +import Text.Pandoc (readMarkdown, writeHtmlString, def) -- Function for translating Markdown to HTML since `Pandoc` has several -- different generators for other markup languages. toHTML :: String -> Text -toHTML = pack . writeHTMLStr . parse - where parse = readMarkdown def - writeHTMLStr = writeHtmlString def +toHTML string = + let parsedOutput = readMarkdown def string + emptyText _ = empty + in either emptyText (pack . writeHtmlString def) parsedOutput {-# INLINE toHTML #-}