konitter / gulp-styledocco Goto Github PK

View Code? Open in Web Editor NEW

13.0 13.0 7.0 200 KB

StyleDocco plugin for gulp.

License: MIT License

JavaScript 100.00%

gulp-styledocco's People

Contributors

Stargazers

Watchers

Forkers

kuniwak ooooooo-q imcarlosdev 418sec

gulp-styledocco's Issues

status of this project?

Looks like the last commit was in 2015. Is this project still maintained or should it be considered EOL?

No longer maintained — Do you want to help?

I think this module is really useful and nice, but not maintained from Feb. this year.
If you are busy, I recommend to assign some collaborators.

I don't want to fork gulp-styledocco and no one wants it.
Because, in ecosystem of gulp, duplicated plugins got blacklisted for the official blacklist.

Always creates docs for all files in a folder

I only want to create the docs for specific files.
Just for testing I tried one file within vendor.

gulp.task('styledocco', function () {
  gulp.src(['./scss/vendor/_bootstrap.scss'])
    .pipe(styledocco({
      out: 'docs',
      name: 'My-Project',
      verbose: true
    }));
});

Output is:

[gulp] Starting 'styledocco'...
[gulp] Finished 'styledocco' after 5.26 ms
[gulp] styledocco: writing /var/www/my-project/scss/vendor/__vendor.scss -> docs/_vendor.html
styledocco: writing /var/www/my-project/scss/vendor/_bootstrap.scss -> docs/bootstrap.html
styledocco: writing /var/www/my-project/scss/vendor/_foundation.scss -> docs/foundation.html
styledocco: writing /var/www/my-project/scss/vendor/index -> docs/index.html

So it is creating docs for all files in that folder.

Using styledocco directly this works:

styledocco scss/vendor/_bootstrap.scss

Any idea?

name with whitespace doens't work

This breaks:

gulp.task('styledocco', function () {
  gulp.src(['./scss/vendor/_bootstrap.scss'])
    .pipe(styledocco({
      out: 'docs',
      name: 'My project',
      verbose: true
    }));
});

[gulp] Using gulpfile /var/www/my-project/gulpfile.js
[gulp] Starting 'styledocco'...
[gulp] Finished 'styledocco' after 5.73 ms
[gulp] 
/usr/lib/node_modules/styledocco/cli.js:277
        throw new SDError('Could not process files.', err);
              ^
Error: Could not process files.
ENOENT, stat 'project'
StyleDocco v0.6.6 running on Node v0.10.25 linux
Options: {"_":["project","/var/www/my-project/scss/vendor/"],"out":"docs","o":"docs","name":"My","n":"My","verbose":"true","minify":true,"$0":"node /usr/bin/styledocco","in":["project","/var/www/my-project/scss/vendor/"],"include":[null],"basePath":"/var/www/my-project/"}


events.js:72
        throw er; // Unhandled 'error' event
              ^
Error: Command failed: 
/usr/lib/node_modules/styledocco/cli.js:277
        throw new SDError('Could not process files.', err);
              ^
Error: Could not process files.
ENOENT, stat 'project'
StyleDocco v0.6.6 running on Node v0.10.25 linux
Options: {"_":["project","/var/www/my-project/scss/vendor/"],"out":"docs","o":"docs","name":"My","n":"My","verbose":"true","minify":true,"$0":"node /usr/bin/styledocco","in":["project","/var/www/my-project/scss/vendor/"],"include":[null],"basePath":"/var/www/my-project/"}

    at ChildProcess.exithandler (child_process.js:637:15)
    at ChildProcess.EventEmitter.emit (events.js:98:17)
    at maybeClose (child_process.js:743:16)
    at Process.ChildProcess._handle.onexit (child_process.js:810:5)

This works:

gulp.task('styledocco', function () {
  gulp.src(['./scss/vendor/_bootstrap.scss'])
    .pipe(styledocco({
      out: 'docs',
      name: 'My-project',
      verbose: true
    }));
});

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.