Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
aiur
Advanced tools
Readme
aiur is a tool to generate style guides with a focus on pattern libraries.
Install aiur in your project:
npm i --save aiur
You then need to write documentation using Markdown:
title: Strong
description: Pretty strong component
This is how we **strong** around here.
```html
Very <strong>strong</strong>
```
This is a regular Markdown file, with two special features:
In addition, you need to provide a aiur.config.js
:
exports.pages = {
"": "./components/welcome.md",
atoms: {
file: "./components/atoms.md",
children: {
button: "./components/button/doc.md",
strong: "./components/strong/doc.md"
}
}
};
exports.title = "Example Pattern Library";
exports.language = "en";
exports.description = "A very good pattern library"
Here you provide the page structure, a title, language and description.
Now you can generate your page by running:
npx aiur
The page will be generated and put into ./dist
. Done. You can see additional
options (like file watching) by running npx aiur -h
.
aiur is licensed under Apache 2.0 License.
FAQs
styleguide generator
The npm package aiur receives a total of 125 weekly downloads. As such, aiur popularity was classified as not popular.
We found that aiur demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.