Skip to content

romain325/elements-core-webcomponents

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

[Elements - OpenAPI Powered API Documentation][elements_landing_page]

Storybook [![CircleCI][circle_ci_image]][circle_ci] [![NPM Downloads][circle_ci_image]][npm] [Stoplight Forest][stoplight_forest]

Fork

This is a fork of https://github.com/stoplightio/elements with the goal to provide "elements-core" as web-components
A big thanks to the creator and maintainor of the original project

Installation

The npm package is available here: https://www.npmjs.com/package/@romain325/elements-core-webcomponents
You can install it with any manager:

npm i @romain325/elements-core-webcomponents

Usage

In your project, add this script tag to your html file
If you're using a framework like Vue, React, Angular, Svelte, ... add it to your index.html file

<script src="node_modules/@romain325/elements-core-webcomponents/dist/web-components.min.js"></script>

And then use it as (for example with vue):

<script setup lang="ts">

const mdText = "# Bonsoir\n\nhello world\n\n## I'm h2";
const type = "article";
</script>

<template>
  <WithSidebar>
    <elements-docs
        :nodeType="type"
        :nodeData="mdText"
        nodeTitle="Wonderful Title"
    ></elements-docs>
  </WithSidebar>
</template

About

@stoplightio/elements-core as web components

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.9%
  • Other 1.1%