https://github.com/joedf/strapdown-topbar

a topbar modification for strapdown.js
https://github.com/joedf/strapdown-topbar

cdnjs html javascript navigationbar plugin strapdown

Last synced: 5 days ago
JSON representation

a topbar modification for strapdown.js

• Host: GitHub
• URL: https://github.com/joedf/strapdown-topbar
• Owner: joedf
• License: mit
• Created: 2015-03-11T04:09:48.000Z (over 9 years ago)
• Default Branch: gh-pages
• Last Pushed: 2023-11-29T07:21:51.000Z (12 months ago)
• Last Synced: 2023-11-29T08:27:14.776Z (12 months ago)
• Topics: cdnjs, html, javascript, navigationbar, plugin, strapdown
• Language: JavaScript
• Homepage: http://joedf.github.io/strapdown-topbar
• Size: 160 KB
• Stars: 20
• Watchers: 6
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# strapdown-topbar

A topbar modification for [strapdown.js](https://github.com/arturadib/strapdown) (markdown-based webpages)  

[![CDNJS](https://img.shields.io/cdnjs/v/strapdown-topbar.svg)](https://cdnjs.com/libraries/strapdown-topbar)

 [![mobile-ready](https://img.shields.io/badge/mobile-ready-blue.svg)](https://github.com/joedf/strapdown-topbar/releases/latest)

 

## Examples

- Example #1: _Left aligned top links_ [[link]](http://joedf.github.io/strapdown-topbar/template.html)

- Example #2: _Right aligned top links_ [[link]](http://joedf.github.io/strapdown-topbar/template-right.html)

- Example #3: (MFixed) _Fixed topbar on mobile devices_ [[link]](http://joedf.github.io/strapdown-topbar/template-mfixed.html)

- Example #4: _Testing Header anchor v-alignment_ [[link]](http://joedf.github.io/strapdown-topbar/header-test.html)

- Example #5: (MFixed) _Testing Header anchor v-alignment_ [[link]](http://joedf.github.io/strapdown-topbar/header-test-mfixed.html)

  

## Usage

Have your topbar setting in the ``.

```HTML

	Home

	About

	

		Item #1

		Item #2

		Item #3

		 

		Item #4

	

	My TOC

	(Powered by StrapDown.js)

```

Then, simply include `strapdown-topbar.js` **AFTER** `strapdown.js`.

```HTML

```

Optionally, you can include the following before the js files to force a header text color to avoid link color styling when not hovered.

```js

var STRAPDOWN_TOPBAR_DEFAULT_COLOR = '#555';

```

**NOTE!** Want more speed? Now available on [cdnjs](https://cdnjs.com/libraries/strapdown-topbar)  

Or even [jsDelivr](https://www.jsdelivr.com): `https://cdn.jsdelivr.net/gh/joedf/strapdown-topbar@latest/assets/strapdown/strapdown-topbar.min.js`