Security News
Opengrep Emerges as Open Source Alternative Amid Semgrep Licensing Controversy
Opengrep forks Semgrep to preserve open source SAST in response to controversial licensing changes.
By Sarah Gooding - Jan 28, 2025
New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More →
@stoplight/elements
Advanced tools
@stoplight/elements
UI components for composing beautiful developer documentation
Installation
Supported in modern browsers and node.
# latest stable
yarn add @stoplight/elements
Usage
import { Page, Provider, TableOfContents } from '@stoplight/elements';
<Provider>
<div className="flex">
<TableOfContents srn="gh/stoplightio/elements" />
<Page className="flex-1" srn="gh/stoplightio/elements/docs/README.md" />
</div>
</Provider>;
Widgets
Elements can be used as a plain JS library.
Load the elements library:
Add the following script tag to the head tag of your website, BEFORE other css or script tags.
<head>
<!-- Stoplight Elements -->
<link rel="stylesheet" href="https://stoplight.io/static/elements/bundle.v1.css" media="print" onload="this.media='all'">
<script async defer src='https://stoplight.io/static/elements/bundle.v1.js' onload="__onElementsLoad()"></script>
<script>
function __onElementsLoad() {
// Let elements know where the Stoplight API is running
SL.config.host = "https://stoplight.io/api";
// Emit the SL.ready event so that any code that needs SL can start using it
window.dispatchEvent(new Event('SL.ready'));
}
</script>
<!-- End Stoplight Elements -->
<!-- ... other script and css elements -->
</head>
Global "SL" object:
The global variable made available on the page after the elements library has been loaded.
declare namespace SL {
interface IWidget {
srn: string;
render(htmlId: string, srn: string): void;
remove(): void;
}
// React.createElement
const createElement: any;
const config: {
host?: string;
token?: string;
components?: any;
};
const elements: {
hub: IWidget;
page: IWidget;
toc: IWidget;
};
}
Render a table of contents onto the page:
// Takes two arguments - the html element id, and a stoplight SRN for the project table of contents to render.
SL.elements.toc.render('my-container-element-id', 'gh/stoplightio/studio-demo');
Render a specific page:
// Takes two arguments - the html element id, and a stoplight SRN for the node to render (article, api, model, http operation, etc).
SL.elements.page.render('my-container-element-id', 'gh/stoplightio/studio-demo/docs/README.md');
Contributing
- Clone repo.
- Create / checkout
feature/{name},chore/{name}, orfix/{name}branch. - Install deps:
yarn. - Make your changes.
- Run tests:
yarn test.prod. - Stage relevant files to git.
- Commit:
yarn commit. NOTE: Commits that don't follow the conventional format will be rejected.yarn commitcreates this format for you, or you can put it together manually and then do a regulargit commit. - Push:
git push. - Open PR targeting the
masterbranch.
FAQs
UI components for composing beautiful developer documentation.
The npm package @stoplight/elements receives a total of 20,381 weekly downloads. As such, @stoplight/elements popularity was classified as popular.
We found that @stoplight/elements 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.
Package last updated on 26 Sep 2019
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.
Related posts
Security News
Node.js EOL Versions CVE Dubbed the "Worst CVE of the Year" by Security Experts
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
By Sarah Gooding - Jan 24, 2025
Security News
cURL Project and Go Security Teams Reject CVSS as Broken
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
By Sarah Gooding - Jan 24, 2025