philj / gulp-kss Goto Github PK
View Code? Open in Web Editor NEWGulp plugin for KSS (Knyle Style Sheets) documentation generation
Gulp plugin for KSS (Knyle Style Sheets) documentation generation
Hello,
I use this code (bellow) in my gulpfile.
var kss = require('gulp-kss');
gulp.task('kss', function() {
gulp.src(config.sass.src)
.pipe(kss({
overview: __dirname + '/sass/styleguide.md'
}))
.pipe(gulp.dest('styleguide/'));
});
config.sass.src
variable contains './src/sass/**/*.scss'
And this will generate me only styleguide/public/ and files as on the picture.
What I do wrong? I want to have a docs! ๐ธ
Using kss-node all the public folder under template is moved automatically to destination, with images and additional CSS files. Gulp-kss does not seem to do the same. My mistake?
Is it possible to updated kss dependencies to match latest release?
It seems that kss version is [email protected], but gulp-kss use [email protected] . Is it correct?
Was having trouble getting up and running with a custom templates. Looks like some handlebars-related issues were resolved in kss-node in the next version up. (v0.4.0) Might be worth a bump
Hi @PhilJ - right now gulp-kss cannot be used as it is not possible to install. There is a lot of outstanding pull requests. Do you have plans on giving it an overhaul at some point?
Does this supports SASS CSS?
The plugin seems to be working correctly; i.e. the styleguide is generated, but gulp does not seem to report that the task has completed. Here's my taskdef:
gulp.task('styleguide-main',function(){
return gulp.src([paths.metaRoot + 'www/css2015/**/*.less'])
.pipe(plugins.kss({
overview: paths.metaRoot + 'www/css2015/styleguide.md',
templateDirectory: paths.metaRoot + 'www/css2015/styleguide-template/'
}))
.pipe(gulp.dest(paths.staticOut + 'styleguide/'));
});
and when I run it on the commandline I only get:
nvioli-4:node nvioli$ gulp styleguide-main
[16:46:32] Using gulpfile ~/git/node/gulpfile.js
[16:46:32] Starting 'styleguide-main'...
nvioli-4:node nvioli$
All other tasks report "Finished".
Please let me know if I can provide any more information.
https://www.npmjs.com/package/gulp-kss is version 0.0.2. This repo's package.json
file is 0.0.1, yet this repo has more recent code than what exists on NPM.
Please consider bumping the version in package.json
and releasing a new package to NPM.
Thanks for creating this package!
I'd like to update the template the style guide is generated from. I'm moving from grunt to gulp and used to do the following (which may not have been the most efficient the first place)...
$ kss-node --init
grunt.initConfig({
styleguide: {
options: {
template: {
src: 'styleguide-template'
},
framework: {
name: 'kss'
}
},
all: {
files: [{
'styleguide': 'sass/**/*.scss'
}]
}
},
Could you tell what the gulp equivalent of "template: {src: 'styleguide-template} would be?
@PhilJ This repository does not provide a license, We can't safely fork it without knowing if we have the right to do so. Would it be possible to consider adding a license file so that we are aware of what rights we do and do not have when using this software? Thanks!
As a side note, there are a lot of PRs. Do you plan on maintaining this any more?
Trying to get this setup and I'm able to get KSS to create new section pages but for some reason is doesn't add these to the navigation.
I am facing following error when running gulp-kss. its working perfectly in node-kss
Console Error
fs.js:427
return binding.open(pathModule._makeLong(path), stringToFlags(flags), mode);
^
Error: ENOENT, no such file or directory '/root/node_modules/gulp-kss/node_modules/kss/lib/template/index.html'
gulp configuration file
gulp.task('styleguide', function(){
return gulp.src([path.styles.src])
.pipe($.kss({
overview: 'app/assets/src/stylesheets/styleguide.md'
}))
.pipe(gulp.dest('styleguide/'));
});
Can you add an option specify a file or something to include custom handlebar helpers, or tell me how I can do that currently without having to edit the index.js
file to require them.
I don't see any documentation from this from kss, kss-node, or gulp-kss.
Currently, I see the styleguide, but my comments don't find my way into it. I assume I need to declare something in my markdown that says "styleguide" and the version so it will trigger the right comments?
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.