diff --git a/documentation/README.md b/documentation/README.md index 1b4b4579a7..95290b5781 100755 --- a/documentation/README.md +++ b/documentation/README.md @@ -21,7 +21,7 @@ In order to edit the documentation Use that if you are on a UNIX system (or have the Ubuntu bash subsystem for Windows 10). ```bash -sudo apt-get install ruby-dev +sudo apt-get install build-essential ruby-dev sudo gem install --http-proxy http://localhost:3128 jekyll ``` diff --git a/documentation/src/main/resources/_config.yml b/documentation/src/main/resources/_config.yml index 3107f14c8a..7143115dc1 100644 --- a/documentation/src/main/resources/_config.yml +++ b/documentation/src/main/resources/_config.yml @@ -97,7 +97,7 @@ defaults: sidebars: - ditto_sidebar -description: "Here be dragons" +description: "Eclipse Ditto Blog" # the description is used in the feed.xml file # needed for sitemap.xml file only diff --git a/documentation/src/main/resources/_data/topnav.yml b/documentation/src/main/resources/_data/topnav.yml index 7355a8facd..ebbf0d154b 100644 --- a/documentation/src/main/resources/_data/topnav.yml +++ b/documentation/src/main/resources/_data/topnav.yml @@ -2,14 +2,14 @@ topnav: - title: Topnav items: - - title: GitHub - external_url: https://github.com/eclipse/ditto - title: Blog url: /blog.html - title: Documentation url: /intro-overview.html - - title: HTTP API Doc + - title: HTTP API url: /http-api-doc.html + - title: GitHub + external_url: https://github.com/eclipse/ditto #Topnav dropdowns topnav_dropdowns: @@ -26,4 +26,4 @@ topnav_dropdowns: - title: Mailing list archives external_url: https://dev.eclipse.org/mhonarc/lists/ditto-dev/ - title: Gitter.im chat - external_url: https://gitter.im/eclipse/ditto + external_url: https://gitter.im/eclipse/ditto \ No newline at end of file diff --git a/documentation/src/main/resources/_includes/incubation_image.html b/documentation/src/main/resources/_includes/incubation_image.html new file mode 100644 index 0000000000..d833770450 --- /dev/null +++ b/documentation/src/main/resources/_includes/incubation_image.html @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/documentation/src/main/resources/_includes/topnav.html b/documentation/src/main/resources/_includes/topnav.html index 8d76d1c008..0d6a4eb6dd 100644 --- a/documentation/src/main/resources/_includes/topnav.html +++ b/documentation/src/main/resources/_includes/topnav.html @@ -13,7 +13,7 @@ - diff --git a/documentation/src/main/resources/_layouts/page.html b/documentation/src/main/resources/_layouts/page.html index e35e36ffaf..aeb8171acd 100644 --- a/documentation/src/main/resources/_layouts/page.html +++ b/documentation/src/main/resources/_layouts/page.html @@ -2,6 +2,8 @@ layout: default --- +{% include incubation_image.html %} +

{{ page.title }}

diff --git a/documentation/src/main/resources/_layouts/start.html b/documentation/src/main/resources/_layouts/start.html index 653db058b8..ee2685dba8 100644 --- a/documentation/src/main/resources/_layouts/start.html +++ b/documentation/src/main/resources/_layouts/start.html @@ -10,6 +10,7 @@ {% include topnav.html %} +{% include incubation_image.html %}
{{ content }} diff --git a/documentation/src/main/resources/_layouts/swagger_layout.html b/documentation/src/main/resources/_layouts/swagger_layout.html index df8201f106..88a293495b 100644 --- a/documentation/src/main/resources/_layouts/swagger_layout.html +++ b/documentation/src/main/resources/_layouts/swagger_layout.html @@ -59,7 +59,12 @@ -
+
+
+ +
+ {% include footer.html %} +
diff --git a/documentation/src/main/resources/css/customstyles.css b/documentation/src/main/resources/css/customstyles.css index 20023fa413..e0e5acaebe 100644 --- a/documentation/src/main/resources/css/customstyles.css +++ b/documentation/src/main/resources/css/customstyles.css @@ -1262,3 +1262,9 @@ h4.panel-title { display:block !important; } } + +@media print { + footer, #tg-sb-sidebar, .incubation-logo { + display: none !important; + } +} \ No newline at end of file diff --git a/documentation/src/main/resources/css/printstyles.css b/documentation/src/main/resources/css/printstyles.css index 64d0f63101..747f0691f4 100644 --- a/documentation/src/main/resources/css/printstyles.css +++ b/documentation/src/main/resources/css/printstyles.css @@ -1,6 +1,3 @@ - -/*body.print .container {max-width: 650px;}*/ - body { font-size:14px; } diff --git a/documentation/src/main/resources/js/customscripts.js b/documentation/src/main/resources/js/customscripts.js index d9b582257c..daf3a96a36 100644 --- a/documentation/src/main/resources/js/customscripts.js +++ b/documentation/src/main/resources/js/customscripts.js @@ -1,32 +1,22 @@ -$('#mysidebar').height($(".nav").height()); +$(function () { + $('#mysidebar').height($(".nav").height()); - -$( document ).ready(function() { - - //this script says, if the height of the viewport is greater than 800px, then insert affix class, which makes the nav bar float in a fixed - // position as your scroll. if you have a lot of nav items, this height may not work for you. - // var h = $(window).height(); - //console.log (h); - // if (h > 800) { - // $( "#mysidebar" ).attr("class", "nav affix"); - // } + //this script says, if the height of the viewport is greater than 800px, then insert affix class, which makes the + // nav bar float in a fixed position as your scroll. if you have a lot of nav items, this height may not work for + // you. var h = $(window).height(); console.log (h); if (h > 800) { $( "#mysidebar" ).attr("class", "nav affix"); } // activate tooltips. although this is a bootstrap js function, it must be activated this way in your theme. - $('[data-toggle="tooltip"]').tooltip({ - placement : 'top' - }); + $('[data-toggle="tooltip"]').tooltip({ placement: 'top' }); /** * AnchorJS */ anchors.add('h2,h3,h4,h5'); -}); - -// needed for nav tabs on pages. See Formatting > Nav tabs for more details. -// script from http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload -$(function() { + // needed for nav tabs on pages. See Formatting > Nav tabs for more details. + // script from + // http://stackoverflow.com/questions/10523433/how-do-i-keep-the-current-tab-active-with-twitter-bootstrap-after-a-page-reload var json, tabsState; - $('a[data-toggle="pill"], a[data-toggle="tab"]').on('shown.bs.tab', function(e) { + $('a[data-toggle="pill"], a[data-toggle="tab"]').on('shown.bs.tab', function (e) { var href, json, parentId, tabsState; tabsState = localStorage.getItem("tabs-state"); @@ -41,14 +31,18 @@ $(function() { tabsState = localStorage.getItem("tabs-state"); json = JSON.parse(tabsState || "{}"); - $.each(json, function(containerId, href) { + $.each(json, function (containerId, href) { return $("#" + containerId + " a[href=" + href + "]").tab('show'); }); - $("ul.nav.nav-pills, ul.nav.nav-tabs").each(function() { + $("ul.nav.nav-pills, ul.nav.nav-tabs").each(function () { var $this = $(this); if (!json[$this.attr("id")]) { return $this.find("a[data-toggle=tab]:first, a[data-toggle=pill]:first").tab("show"); } }); -}); + + $('nav li').on('click', { + $(this).removeClass('hidden') + }) +}); \ No newline at end of file