WIP - DO NOT MERGE - Documentation overhaul

[markusjura]

Changed documentation styling:

• Using now a white background
• Changed font color from navy to slate
• Changed code blocks (code and pre)
• Increased relative width of documentation text and reduced relative width of table of content
• Increased padding of p sections
• Reduced row-widthfrom 1200 to 1000 which results in the same row margin of 62.5em as on typesafe.com
• Changed white-dkr styling to white-ltr

[huntc]

Thanks for this - has this been done in conjunction with @rasummer ?

[markusjura]

The idea was that I am creating a first draft and afterwards he does a review

@rasummer: Can you please do a review of the styling?

@huntc: Would be also nice to get feedback about the styling from you and the team.

The styling is IMO complete, but there are still some other topics missing which has been described in the ConductR documentation improvements doc:

• Use code tabs (as in Play)
• Add HTML ids for each headline
• Add a clickable icon which links to the chapter (Akka has that as well)
• Add documentation item to top navigation bar
• Remove toc from landing page (separate section, not part of documentation)
• Restructuring the table of content

Would like to work on these topics today.

[rasummer]

@markusjura @huntc I'll try to take a look today, if not then Tuesday.

[markusjura]

UPDATE

• Top navigation menu has changed. Added the section documentation
• Footer has changed and only displays the items of the top navigation bar (instead of the documentation toc)
• Landing page doesn't contain the documentation toc anymore
• HTML ids for each headline have been added by upgrading to the latest play-doc version
• Anchor icon for each headline has been added to play-doc with the PR #17. The corresponding in project-doc styling has been added with the commit markusjura@17307ec. When play-doc has merged the PR we can update the version here in this project to add the feature.
• Header is not fixed anymore. This is necessary in order that the new anchor icon linking to the correct position within the page
• Added code syntax highlighting with commit 06dfc22

[rasummer]

@markusjura @huntc I've taken a look at the updates and they LGTM.

Per our discussion Markus, here's the recommendation for a CSS fix for extra long words that cause html elements such as tables to break out of their containing columns. For example, the first table on the following page is wider than the containing column: http://conductr.typesafe.com/developer/Bundle-Env.html

.wrap {
  word-break: break-all;
}

The documentation creator would add the class of 'wrap' to a parent element such as the <td> that contains the long word. For example: <td class="wrap">

[huntc]

Thanks for the feedback @rasummer !

@markusjura please note that this no longer merges. Also, I'm changing the title to note that this is still a WIP. Please change the title once you're ready for it to be merged.

[huntc]

LGTM - merge at will.

Awesome work!

[markusjura]

UPDATE

• Added version of documentation to sidebar
• HTTP URI contains now the version of the documentation (currently 1.0.x)
• Added support to list down the toc on the documentation homepage (see here)
• Resources (e.g. images) are now streamed to the client (non-blocking)

Attention
This PR need to be merged together with the #32 of conductr-doc.

Testing
This PR can be tested (without merging the PR from project-doc) by changing the documentation archive in ConductRDocRendererModule.scala from https://github.com/typesafehub/conductr-doc/archive/master.zip to https://github.com/markusjura/conductr-doc/archive/restructure-content.zip