
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
styledocco
Advanced tools
_______ __ __ _____
| __| |_.--.--| |-----.| \-----.----.----.-----.
|__ | _| | | | -__|| -- | _ | __| __| _ |
|_______|____|___ |__|_____||_____/_____|____|____|_____|
|_____|
StyleDocco takes your stylesheets and generates style guide documents with the processed stylesheets applied to the documents.
styledocco --name 'My Site' main.css
will generate docs/main.html
with all the comments from the file (passed through GitHub flavored Markdown) in one column, and all the code in another column.
The CSS in main.css
will be applied to the page. This means you can add sample HTML content in the comments of your CSS file, and have it rendered in the browser using that same CSS.
If your project includes a README
file, it will be used as the base for an index.html
.
StyleDocco will add docs.css
with some default styles to your documentation, but you might want to modify it to make it fit with your project.
StyleDocco will automatically compile any SASS, SCSS, Less or Stylus code before it is applied to the page. Hidden files and SASS partials will be ignored.
StyleDocco requires Node.js.
npm install -g styledocco
styledocco [options] [INPUT]
--name
, -n
Name of the project (required)--out
, -o
Output directory (default: "docs")--tmpl
Directory for custom index.jade
and docs.jade
templates (optional)--overwrite
Overwrite existing files (docs.css
) in target directory./* <button class="btn primary">Primary</button>
Provides extra visual weight and identifies the primary action in a set of buttons */
.btn.primary {
background: blue;
color: white;
}
Would output an HTML document with one column displaying the rendered button followed by the description, and another column with the code. The code will also be included in a style
element of the document.
See the examples
folder for more in-depth examples.
Thanks to:
FAQs
Generate documentation and style guides with design patterns from stylesheets.
The npm package styledocco receives a total of 4,098 weekly downloads. As such, styledocco popularity was classified as popular.
We found that styledocco demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers 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
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.