HTML5 outliner #

!Supported: io.js
!Supported: node v0.10
!Supported: node v0.12

!Supported: phantom.js v1.9
!Supported: jsdom v3.x
!Supported: jsdom v4.x


h5o is an implementation of the HTML5 outline algorithm in JavaScript. Specifications:

* W3C Recommendation 28 October 2014
* WHATWG Living Standard

If you like this tool, please consider a charitable donation to Ocean Voyages Institute (Project Kaisei).

Usage ##

npm install h5o (as of 2015, you should not be using any other way of managing your JS dependencies, but
you can still download latest release)

* Use the UMD module available in dist/outliner.min.js with a fallback to global HTML5Outline or
var HTML5Outline = require('h5o') in node or browserify
* var outline = HTML5Outline(startFrom) (you likely want startFrom to be document.body). Returned value is an outline object, with sections.
* outline.asHTML( [ options | createLinks ]) to get HTML with an ordered list.
- If options.createLinks (or createLinks) is true, the DOM will be amended with IDs and the list will contain links for navigation.
- If options.skipToHeader is true, the outline HTML will only include the sub-sections of the first section in
the outline (which is usually the body), i.e. it will only contain the sections of the documents, skipping
the title of the whole document.

Visit https://h5o.github.io/ for the Chrome extension and bookmarklet.

Development ##

$3

1. install node or iojs (includes npm)
2. npm install -g grunt-cli
4. npm install in your local clone of this repo

$3

Run grunt test
* Will launch buster server and capture the system default browser with it
* Will run tests in node using jsdom and jsdom-compat
* Will run tests in PhantomJS

Run grunt watch
* Will watch for file changes and rebuild/run tests automatically

History ##

$3

* ???

$3

* Fix for h5o/h5o-chrome #10 / #18

$3

* Split off bookmarklet into a separate repo: https://github.com/h5o/h5o-bookmarklet

$3

* Bookmarklet no longer part of GH releases
* Some styling for bookmarklet.html

$3

* Auto-publish in npm via Travis

$3

* Fixed #18: Add an option to skip the top-level header when generating a ToC (thanks @jyasskin)
* Split up getHeadingElementRank into getRankingHeadingElement and getRank
* Section no longer has asHTML (out of scope)

$3

* Outline is not a separate object of its own
* getSectionHeadingRank cleanup
* Travis runs tests in both - jsdom v4.x and v3.x via jsdom-compat

$3

* Throw when non-sectioning root / content element passed in for outlining
* Cleanup

$3

* More tests

$3

* Added jsdom@4.x on io.js to the test matrix
* Fixed implied headings to follow the spec - this actually means the previous implementation was
incorrect - updated the following tests: navfirst, issue-13. Issue #13 was partly invalid.
* Added more examples from the spec

$3

* Updated to the latest specified algorithm
* Fixed #11: HTML entity escaping
* Fixed #13: problems with sectioning root elements inside the outline
* Properly handling of hgroup without any h1-h6 inside

$3

* Renamed grunt start-dev in favor a simpler grunt watch
* Bookmarklet now goes via browserify
* Bookmarklet works in Firefox again (fixes #6)
* Fixed #9

$3

* Travis deploy (second try)

$3

* Travis deploy

$3

* Run tests on node 0.12 and io.js
* Run tests in phantom.js as well as real browsers

$3

* README updates
* ignore .grunt folder

$3

* Using browserify instead of concatenation
* Made tests pass with jsdom
* Updated browsers and dependencies

$3

* Replaced intern with buster

$3

* Using ejs to generate bookmarklet HTML
* Using gh-pages to publish the bookmarklet

$3

* Using intern
* Using SauceLabs
* Using travis

$3

* Rewritten build scripts with grunt
* Split away Chrome extension, removed Opera/Firefox extension code

$3

* First version published in npm

$3

Originally lived on Google Code, if you like archeology

Contributors ##

* Dominykas Blyžė
* Jeffrey Yasskin