Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
live-guide
Advanced tools
THIS IS VERY MUCH UNDER DEVELOPMENT, API IS SURE TO CHANGE
Use as module:
const styleguide = require('live-guide');
const options = {
input: "src/**/*.css",
resources: ['path/to/compiled/style.css', 'path/to/other/required/files/app.js']
};
styleguide(options)
.then(function(data) {
// Do something after styleguide is compiled.
// data refers to an array of objects containing all the relevant data from your build
});
Use in command line:
$ npm install --global live-guide
$ live-guide --input="path/to/**/*.css" --output=/var/www/styleguide --resource path/to/style.css another/path/here.js
Options:
--input, -i file(s) (glob pattern) that should be evaulated and built into
the Styleguide [required]
--output, -o Where should the output styleguide go? Defaults to current
working directory /styleguide
--resource, -r additional resources to be loaded into the code example
iframes [array]
--name, -n name for the style guide or product
--help, -h Show help [boolean]
Description: Contribute the code to someone
Example:
/* @example Jan Doe */
// @author Jon Doe
Description: Set a description for this section of the styleguide, generally used after an @title
Example:
/* @description This describes your component or module */
//@description This describes your component or module
Description: A code example, similar to writing code blocks in Markdown
Any example written in a single line comments will need a blank comment line //
after it.
Example:
//@example
//<button class="btn">Click me, I do stuff!</button>//
/*
@example
*<button class="btn">Click me, I do stuff!//</button>
*/
Description: The title of the component, module or API you are developing
Description: Let users know what needs to be done in this section of your style guide
Description: Add a link to the styleguide, automatically opens in a new tab
Description: If you want the file name to be different than the title, for instance setting up an index page. There is no need to provide a file extension
FAQs
Generate style guides based on commented style sheets.
The npm package live-guide receives a total of 1 weekly downloads. As such, live-guide popularity was classified as not popular.
We found that live-guide demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.