Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature navigation #920

Merged
merged 10 commits into from
Apr 20, 2016
Merged

Feature navigation #920

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
451f149
side nav added
junaidrsd Apr 1, 2016
6040b04
side navigation option added to stylebook conf
junaidrsd Apr 11, 2016
0450aa2
menu styles added for mobile
junaidrsd Apr 11, 2016
7d21a87
fixed position navbar
junaidrsd Apr 12, 2016
9638674
absolute positioned side nav
junaidrsd Apr 12, 2016
d476594
fix the broken test
junaidrsd Apr 12, 2016
d0cb8ec
refactor code
junaidrsd Apr 12, 2016
1268f4c
test coverage added
junaidrsd Apr 12, 2016
2194fb0
side nav option documented
junaidrsd Apr 13, 2016
5c034d4
refactoring code
junaidrsd Apr 19, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ using KSS notation. It can be used as a command line utility, gulp task or Grunt
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Usage](#usage)
- [Prerequisites](#prerequisites)
- [With gulp](#with-gulp)
Expand All @@ -29,6 +30,7 @@ using KSS notation. It can be used as a command line utility, gulp task or Grunt
- [Providing additional CSS](#providing-additional-css)
- [Providing additional JavaScript](#providing-additional-javascript)
- [onRendered event](#onrendered-event)
- [Adding new section in between](#adding-new-section-in-between)
- [Demo](#demo)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Expand Down Expand Up @@ -202,6 +204,11 @@ This string is used as a page title and in the page header

These HTML elements are injected inside the style guide head-tag.

<a name="option-sideNav"></a>
**sideNav** (boolean, optional, default: false)

Enables side navigation. When this option parameter is enabled, style guide will switch to side navbar.

<a name="option-beforeBody"></a>
**beforeBody** (array or string, optional)

Expand Down
1 change: 1 addition & 0 deletions gulpfile.babel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ gulp.task('dev:generate', () => {
return gulp.src(['lib/app/css/*.css'])
.pipe(styleguide.generate({
title: 'SC5 Styleguide',
sideNav: true,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this be the new default value, so if you update toNav changes to sideNav? If so, I would change default value to false.

server: true,
rootPath: outputPath,
overviewPath: 'README.md',
Expand Down
Loading