Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.1.0 WIP #19

Merged
merged 29 commits into from May 3, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
cbb9a7e
added support for bower
neocotic May 1, 2013
ac531bb
Merge pull request #18 from neocotic/bower-support
neocotic May 1, 2013
8dbae4e
replaced build process and test framework
neocotic May 1, 2013
2f33757
updated the markdown docs to reflect latest changes to build process
neocotic May 1, 2013
a13fc0d
updated install section of readme
neocotic May 1, 2013
516b0f0
Merge pull request #20 from neocotic/grunting
neocotic May 1, 2013
97057e3
started big code update and tidy
neocotic May 1, 2013
01a8094
only using glob when a single argument is passed
neocotic May 2, 2013
dbf69b7
removed globbing
neocotic May 2, 2013
6f5276e
improved command line code
neocotic May 2, 2013
9c78dd2
improved quality of code and added more documentation
neocotic May 2, 2013
1c7af48
last minute final improvements
neocotic May 2, 2013
8e2a41a
Merge pull request #21 from neocotic/code-update
neocotic May 2, 2013
ca1f556
started work on improve order and unordered list handling
neocotic May 2, 2013
d76df1c
vastly improved the handling of lists and now supports nested lists
neocotic May 2, 2013
1b3c019
Merge pull request #22 from neocotic/better-lists
neocotic May 2, 2013
9b91660
preparing for v2.1.0 and fixing some more bugs
neocotic May 2, 2013
f50b9b0
replaced optparse with commander to fix CLI issues
neocotic May 3, 2013
917d08c
moved CLI test teardown directly onto fixtures group;
neocotic May 3, 2013
c56d18f
updated change log
neocotic May 3, 2013
0470e6b
fixed tests
neocotic May 3, 2013
8ea2ff8
added windows compatibility section to readme
neocotic May 3, 2013
e2ea8ab
fixed formatting in readme
neocotic May 3, 2013
713e1a4
updated usage in readme
neocotic May 3, 2013
fe8571d
fixed syntax highlighting in readme
neocotic May 3, 2013
edfeb37
changed CLI example in readme
neocotic May 3, 2013
7e77bb1
added option for inline link generation
neocotic May 3, 2013
e801f98
Merge pull request #23 from neocotic/no-link-ref-option
neocotic May 3, 2013
5ba3164
roll v2.1.0
neocotic May 3, 2013
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions .gitignore
@@ -1,9 +1,7 @@
node_modules/
npm-debug.log

test/output/

.DS_Store?
ehthumbs.db
Icon?
Thumbs.db
Thumbs.db
2 changes: 0 additions & 2 deletions .npmignore

This file was deleted.

3 changes: 2 additions & 1 deletion .travis.yml
@@ -1,4 +1,5 @@
language: node_js
node_js:
- 0.8
- 0.6
before_script:
- npm install -g grunt-cli
2 changes: 1 addition & 1 deletion AUTHORS.md
@@ -1,4 +1,4 @@
# Authors ordered by first contribution

* Trevor Jim <trever@research.att.com>
* Alasdair Mercer <mercer.alasdair@gmail.com>
* Alasdair Mercer <mercer.alasdair@gmail.com>
34 changes: 29 additions & 5 deletions CHANGES.md
@@ -1,19 +1,43 @@
# Change Log
2013.05.03, Version 2.1.0

## 2013.02.04, Version 2.0.2
* [#18](https://github.com/neocotic/html.md/issues/18): Add support for [bower][] installations
* [#20](https://github.com/neocotic/html.md/issues/20): Replace `Cakefile` with new [grunt][] build process
* [#20](https://github.com/neocotic/html.md/issues/20): Replace [tap][] test framework with [nodeunit][]
* [#21](https://github.com/neocotic/html.md/issues/21): Removed [CoffeeScript][] as a runtime dependency
* [#21](https://github.com/neocotic/html.md/issues/21): Update [jsdom][] to v0.6.0 to fix known bugs
* [#21](https://github.com/neocotic/html.md/issues/21): Improve compatibility with the Windows platform
* [#21](https://github.com/neocotic/html.md/issues/21): Improve code and documentation quality and standards
* [#21](https://github.com/neocotic/html.md/issues/21): Fix `absolute` option to also apply to `img` elements
* [#21](https://github.com/neocotic/html.md/issues/21): Improve compatibility with older browsers
* [#22](https://github.com/neocotic/html.md/issues/22): Improve handling of ordered and unodered lists
* [#22](https://github.com/neocotic/html.md/issues/22): Support nested lists
* [#23](https://github.com/neocotic/html.md/issues/23): Add option to support inline link style
* Replace [optparse][] with [commander][]
* Lots of bug fixes and optimizations

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
2012.12.12, Version 2.0.1

* [#8](https://github.com/neocotic/html.md/issues/8): Fix incorrect version

## 2012.12.11, Version 2.0.0
2012.12.11, Version 2.0.0

* [#1](https://github.com/neocotic/html.md/issues/1): Check inline style attribute to see if elements are hidden
* [#2](https://github.com/neocotic/html.md/issues/2): Add command line interface
* [#3](https://github.com/neocotic/html.md/issues/3): Create unit test suite
* [#4](https://github.com/neocotic/html.md/issues/4): Rewrite code in CoffeeScript
* [#5](https://github.com/neocotic/html.md/issues/5): Add compatibility support for node.js
* [#6](https://github.com/neocotic/html.md/issues/6): Add build process
* [#6](https://github.com/neocotic/html.md/issues/6): Add build process

[bower]: http://twitter.github.io/bower/
[coffeescript]: http://coffeescript.org
[commander]: http://visionmedia.github.io/commander.js/
[grunt]: http://gruntjs.com
[jsdom]: https://github.com/tmpvar/jsdom
[nodeunit]: https://github.com/caolan/nodeunit
[optparse]: https://github.com/jfd/optparse-js
[tap]: https://github.com/isaacs/node-tap
31 changes: 14 additions & 17 deletions CONTRIBUTING.md
@@ -1,7 +1,7 @@
# Contributing

Here are some guidelines that we'd like contributors to follow so that we can
have a chance of keeping things right.
Here are some guidelines that we'd like contributors to follow so that we can have a chance of
keeping things right.

## Getting Starting

Expand All @@ -15,27 +15,25 @@ have a chance of keeping things right.

* Create a topic branch from where you want to base your work
* This is usually the master branch
* Only target release branches if you are certain your fix must be on that
branch
* To quickly create a topic branch based on master; `git branch
fix/master/my_contribution master` then checkout the new branch with `git
checkout fix/master/my_contribution`
* Only target release branches if you are certain your fix must be on that branch
* To quickly create a topic branch based on master;
`git branch fix/master/my_contribution master` then checkout the new branch with
`git checkout fix/master/my_contribution`
* Avoid working directly on the `master` branch
* Make commits of logical units
* Check for unnecessary whitespace with `git diff --check` before committing
* Make sure your commit messages are in the proper format
```
(#99999) Make the example in CONTRIBUTING imperative and concrete

Without this patch applied the example commit message in the CONTRIBUTING
document is not a concrete example. This is a problem because the
contributor is left to imagine what the commit message should look like
based on a description rather than an example. This patch fixes the
Without this patch applied the example commit message in the CONTRIBUTING document is not a
concrete example. This is a problem because the contributor is left to imagine what the commit
message should look like based on a description rather than an example. This patch fixes the
problem by making the example concrete and imperative.

The first line is a real life imperative statement with a ticket number
from our issue tracker. The body describes the behavior without the patch,
why this is a problem, and how the patch fixes the problem when applied.
The first line is a real life imperative statement with a ticket number from our issue tracker.
The body describes the behavior without the patch, why this is a problem, and how the patch
fixes the problem when applied.
```
* Make sure you have added the necessary tests for your changes
* Run *all* the tests to assure nothing else was accidentally broken
Expand All @@ -48,13 +46,12 @@ have a chance of keeping things right.
```
* Push your changes to a topic branch in your fork of the repository
* Submit a pull request to neocotic's repository
* Update your issue to mark that you have submitted code and are ready for it
to be reviewed
* Update your issue to mark that you have submitted code and are ready for it to be reviewed
* Include a link to the pull request in the issue

# Additional Resources

* [html.md repository](https://github.com/neocotic/html.md)
* [Issue tracker](https://github.com/neocotic/html.md/issues)
* [General GitHub documentation](http://help.github.com)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests)
* [GitHub pull request documentation](http://help.github.com/send-pull-requests)
111 changes: 0 additions & 111 deletions Cakefile

This file was deleted.

49 changes: 49 additions & 0 deletions Gruntfile.coffee
@@ -0,0 +1,49 @@
module.exports = (grunt) ->

# Configure
# ---------

grunt.initConfig

pkg: grunt.file.readJSON 'package.json'

clean:
docs: ['docs/*']
lib: ['lib/*']
dist: ['dist/*']

coffee:
all:
expand: yes
cwd: 'src'
src: '**/*.coffee'
dest: 'lib'
ext: '.js'

docco:
all:
options: output: 'docs'
src: ['src/**/*.coffee']

nodeunit:
all: ['test/**/*_test.coffee']

uglify:
all:
files: 'dist/md.min.js': ['lib/md.js']
options:
banner: """
/*! <%= pkg.name %> v<%= pkg.version %> | (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %> | <%= pkg.licenses[0].type %> License
Make.text v1.5 | (c) 2007 Trevor Jim
*/
"""

# Tasks
# -----

for dependency of grunt.config.data.pkg.devDependencies when ~dependency.indexOf 'grunt-'
grunt.loadNpmTasks dependency

grunt.registerTask 'build', ['clean', 'coffee', 'docco', 'uglify']
grunt.registerTask 'default', ['build', 'test']
grunt.registerTask 'test', ['nodeunit']
16 changes: 8 additions & 8 deletions INSTALL.md
@@ -1,21 +1,21 @@
# Build Requirements
In order to build [html.md][], you need to have the following install [git][] 1.7+ and the latest version of [node.js][] 0.6+ (which includes [npm][]).
In order to build [html.md][], you need to have the following install [git][] 1.7+ and [node.js][]
0.6+ (which includes [npm][]).

# Building
Follow these steps to build [html.md][];

1. Clone a copy of the main [html.md git repository](https://github.com/neocotic/html.md) by running `git clone git://github.com/neocotic/html.md.git`
1. Clone a copy of the main [html.md git repository](https://github.com/neocotic/html.md) by
running `git clone git://github.com/neocotic/html.md.git`
2. `cd` to the repository directory
3. Ensure you have all of the dependencies by entering `npm install`
4. For the compiled JavaScript `cd` to the repository directory and enter `cake build`
4. For the compiled JavaScript `cd` run `grunt build`
* Outputs `md.js` to the `lib` directory
* Outputs `md.min.js` (optimised version) to the `dist` directory
5. To run the full test suite enter `cake test`
6. To update the documentation enter `cake docs`
* Outputs `md.min.js` (compressed version) to the `dist` directory
* Outputs documentation to the `docs` directory
* Not currently working on Windows as it uses linux shell commands
5. To run the full test suite enter `grunt test`

[git]: http://git-scm.com
[node.js]: http://nodejs.org
[npm]: http://npmjs.org
[html.md]: http://neocotic.com/html.md
[html.md]: http://neocotic.com/html.md
2 changes: 1 addition & 1 deletion LICENSE.md
Expand Up @@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.