SC5 / sc5-styleguide

Styleguide generator is a handy little tool that helps you generate good looking styleguides from stylesheets using KSS notation
http://styleguide.sc5.io/
MIT License
1.26k stars 167 forks source link

Menu items not showing up #914

Closed shainanigans closed 8 years ago

shainanigans commented 8 years ago

I've reviewed the demo structure and KSS and can't work out why the menu items are not showing up on my own styleguide. After serving the page, I only see the "Overview" menu item.

(Relevant) Folder Structure:

Gulp Task:

// generate Styleguide
var styleguide = require('sc5-styleguide');
var outputPath = 'styleguide';
gulp.task('styleguide:generate', function() {
  return gulp.src('*.scss')
    .pipe(styleguide.generate({
        title: 'Boilerplate Styleguide',
        server: true,
        rootPath: outputPath,
        overviewPath: 'README.md'
      }))
    .pipe(gulp.dest(outputPath));
});

// apply styles
gulp.task('styleguide:applystyles', function() {
  return gulp.src('master.scss')
    .pipe(sass({
      errLogToConsole: true
    }))
    .pipe(styleguide.applyStyles())
    .pipe(gulp.dest(outputPath));
});

Relevant section of master.scss that I'm using for testing the styleguide:

@import "components/typography";

Part of _typography.scss that I'm using for testing:

/*
Colors and typography
This section describes base colors and typography
Styleguide 1.0
*/

/*
Links

Normal links.

markup:
<a>This is a link</a>

Styleguide 1.1
*/

a {
    @include transition(all 0.2s ease-in-out);
    color: $link-color;
    text-decoration: none;
    &:hover {
        color: $link-hover-color;
        text-decoration: underline;
    }
    &:focus {
        color: $link-hover-color;
        outline: 1px dotted $link-color;
    }
}

Is this user error... or something else? (Either way, advice appreciated!)

varya commented 8 years ago

The path you provide to as a gulp source is looking for *.scss files in the root of your project, and there is nothing there. BTW, next time try to ask at StackOverflow. There is a lot of developers there ready to help, so you will get an answer for basic questions much sooner.