mirror of
https://github.com/jlengrand/detekt.git
synced 2026-03-10 08:11:23 +00:00
* Don't link to docs that don't exist * Add generateDocumentation task to documentation task group * Only process KDoc for detekt-api * Generate empty javadoc artifacts * Link documentation to JDK 8 * Publish detekt-api docs to docs site * Use relative URLs when linking internally in docs Since KDoc output is in a subfolder in the pages directory, previous assumptions about how to access static resources no longer hold. Instead it's necessary to use relative URLs which will resolve to the correct URL regardless of whether the site is hosted locally or on GitHub pages. * Don't remove slashes within generated URL Pages in subfolders need the slashes within the URL to properly specify the folder path.
82 lines
4.3 KiB
HTML
82 lines
4.3 KiB
HTML
<!-- Navigation -->
|
|
<nav class="navbar navbar-inverse navbar-static-top">
|
|
<div class="container topnavlinks">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<a class="fa fa-home fa-lg navbar-brand" href="index.html"> <span class="projectTitle"> {{site.topnav_title}}</span></a>
|
|
</div>
|
|
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<!-- toggle sidebar button -->
|
|
<li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
|
|
<!-- entries without drop-downs appear here -->
|
|
|
|
{% assign topnav = site.data[page.topnav] %}
|
|
{% assign topnav_dropdowns = site.data[page.topnav].topnav_dropdowns %}
|
|
|
|
{% for entry in topnav.topnav %}
|
|
{% for item in entry.items %}
|
|
{% if item.external_url %}
|
|
<li><a href="{{item.external_url}}" target="_blank">{{item.title}}</a></li>
|
|
{% elsif page.url contains item.url %}
|
|
<li class="active"><a href="{{item.url | remove: "/"}}">{{item.title}}</a></li>
|
|
{% else %}
|
|
<li><a href="{{item.url | remove: "/"}}">{{item.title}}</a></li>
|
|
{% endif %}
|
|
{% endfor %}
|
|
{% endfor %}
|
|
<!-- entries with drop-downs appear here -->
|
|
<!-- conditional logic to control which topnav appears for the audience defined in the configuration file.-->
|
|
{% for entry in topnav_dropdowns %}
|
|
{% for folder in entry.folders %}
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown">{{ folder.title }}<b class="caret"></b></a>
|
|
<ul class="dropdown-menu">
|
|
{% for folderitem in folder.folderitems %}
|
|
{% if folderitem.external_url %}
|
|
<li><a href="{{folderitem.external_url}}" target="_blank">{{folderitem.title}}</a></li>
|
|
{% elsif page.url contains folderitem.url %}
|
|
<li class="dropdownActive"><a href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
|
|
{% else %}
|
|
<li><a href="{{folderitem.url | remove: "/"}}">{{folderitem.title}}</a></li>
|
|
{% endif %}
|
|
{% endfor %}
|
|
</ul>
|
|
</li>
|
|
{% endfor %}
|
|
{% endfor %}
|
|
{% if site.feedback_disable == null or site.feedback_disable == false %}
|
|
{% include feedback.html %}
|
|
{% endif %}
|
|
<!--comment out this block if you want to hide search-->
|
|
<li>
|
|
<!--start search-->
|
|
<div id="search-demo-container">
|
|
<input type="text" id="search-input" placeholder="{{site.data.strings.search_placeholder_text}}">
|
|
<ul id="results-container"></ul>
|
|
</div>
|
|
<script src="{{ "js/jekyll-search.js" | relative_url }}" type="text/javascript"></script>
|
|
<script type="text/javascript">
|
|
SimpleJekyllSearch.init({
|
|
searchInput: document.getElementById('search-input'),
|
|
resultsContainer: document.getElementById('results-container'),
|
|
dataSource: '{{ "search.json" | relative_url }}',
|
|
searchResultTemplate: '<li><a href="{url}" title="{{page.title | escape }}">{title}</a></li>',
|
|
noResultsText: '{{site.data.strings.search_no_results_text}}',
|
|
limit: 10,
|
|
fuzzy: true,
|
|
})
|
|
</script>
|
|
<!--end search-->
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- /.container -->
|
|
</nav>
|