elements
Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown.
File Explorer
Download Latest Version (.zip)- config.yml
- release.md
- auto-approve.yml
- auto-merge-dependabot.yml
- jira-issue-label-added.yaml
- perform-lockfile-maintenance.yml
- test-and-release.yml
- CODEOWNERS
- dependabot.yml
- pull_request_template.md
- google-fonts.css
- main.js
- manager.js
- preview.jsx
- theme.js
- api.cy.ts
- stoplight-project.cy.ts
- zoom.openapi.yml
- index.js
- commands.js
- e2e.js
- index.d.ts
- DemoNavbar.tsx
- ElementsAPI.tsx
- todo.v1.yaml
- App.tsx
- constants.ts
- context.ts
- index.tsx
- common.js
- dev.js
- prod.js
- .babelrc
- .env
- index.html
- package.json
- README.md
- tsconfig.json
- dev-portal-angular.md
- dev-portal-options.md
- html.md
- introduction.md
- react.md
- search-component.md
- angular.md
- elements-options.md
- html.md
- introduction.md
- react.md
- great-api-docs.md
- hello-world.md
- layouts.md
- projectId.png
- readme-header.svg
- elements-vs-dev-portal.md
- introduction.md
- api.component.html
- api.component.ts
- home.component.html
- home.component.ts
- stoplight-project.component.html
- stoplight-project.component.ts
- app-routing.module.ts
- app.component.css
- app.component.html
- app.component.ts
- app.module.ts
- environment.prod.ts
- environment.ts
- favicon.ico
- index.html
- main.ts
- polyfills.ts
- styles.css
- .gitignore
- angular.json
- LICENSE
- package.json
- README.md
- tsconfig.app.json
- tsconfig.json
- yarn.lock
- index.html
- project.html
- favicon.ico
- index.html
- API.tsx
- Navigation.tsx
- NotFound.tsx
- Search.tsx
- StoplightProject.tsx
- App.tsx
- index.css
- index.tsx
- react-app-env.d.ts
- serviceWorker.ts
- .env
- .eslint.js
- .gitignore
- .prettierrc.js
- license.txt
- package.json
- README.md
- tsconfig.json
- yarn.lock
- index.html
- index.html
- index.html
- package.json
- serve-files.js
- yarn.lock
- main.js
- manager.js
- preview.jsx
- badgesForSchema.ts
- Instagram.ts
- simpleApiWithInternalOperations.ts
- simpleApiWithoutDescription.ts
- todosApiBundled.ts
- zoomApiYaml.ts
- utils.test.ts
- APIWithResponsiveSidebarLayout.tsx
- APIWithSidebarLayout.tsx
- APIWithStackedLayout.tsx
- utils.ts
- API.spec.tsx
- API.stories.tsx
- API.tsx
- story-helper.tsx
- useExportDocumentProps.spec.tsx
- useExportDocumentProps.tsx
- oas.spec.ts
- index.ts
- oas2.ts
- oas3.ts
- types.ts
- Api.stories.tsx
- components.ts
- index.ts
- index.ts
- styles.css
- jest.config.js
- LICENSE
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- web-components.config.js
- main.js
- manager.js
- preview.jsx
- basic.md
- kitchen-sink.md
- long-page-heading.md
- multiple-try-its.md
- schema-with-refs.ts
- model-with-no-examples.json
- model-with-one-example.json
- model-with-three-examples.json
- application-octet-stream-post.ts
- base64-file-upload.ts
- big-response.ts
- bundled-parameter.ts
- empty-response.ts
- examples-request-body.ts
- head-todos.ts
- invalid-response-example.ts
- multipart-formdata-post.ts
- operation-minimal.ts
- operation-parameters.ts
- operation-with-examples.ts
- operation-without-servers.ts
- patch-todos.ts
- put-todos.ts
- referenced-body.ts
- request-body-empty-schema.ts
- request-body.ts
- securedOperation.ts
- security-basic.ts
- security-bearer.ts
- simple-get.ts
- simple.ts
- string-numeric-enums.ts
- urlencoded-post-oneof.ts
- urlencoded-post.ts
- vendor-extensions.ts
- with-url-variables.ts
- x-code-samples.ts
- circular.ts
- contact.json
- media-entry.json
- simple.json
- todo-full.v1.json
- todo-partial.v1.json
- user.v1.json
- index.ts
- petstore.ts
- with-unnamed-servers.ts
- with-url-variables.ts
- without-origin.ts
- nested.ts
- studio-template.ts
- studio.ts
- http-request.json
- LinkHeading.spec.tsx
- Article.spec.tsx
- Article.stories.tsx
- index.tsx
- Badges.tsx
- Body.tsx
- Callbacks.tsx
- HttpOperation.spec.tsx
- HttpOperation.stories.ts
- HttpOperation.tsx
- index.ts
- Parameters.spec.tsx
- Parameters.tsx
- Request.tsx
- Responses.tsx
- AdditionalInfo.stories.ts
- AdditionalInfo.tsx
- ExportButton.tsx
- HttpService.spec.tsx
- HttpService.stories.ts
- HttpService.tsx
- index.ts
- SecuritySchemes.tsx
- ServerInfo.tsx
- index.ts
- Model.spec.tsx
- Model.stories.tsx
- Model.tsx
- index.ts
- PanelContent.tsx
- Docs.stories.tsx
- Docs.tsx
- index.ts
- NodeVendorExtensions.tsx
- Sections.tsx
- Skeleton.tsx
- story-helper.ts
- story-renderer-helper.tsx
- TwoColumnLayout.tsx
- MobileTopNav.tsx
- ResponsiveSidebarLayout.tsx
- SidebarLayout.tsx
- Loading.tsx
- CodeComponent.spec.ts
- CodeComponent.tsx
- Provider.tsx
- ReactRouterLink.tsx
- ResolvedImage.tsx
- ScrollToHashElement.tsx
- index.tsx
- MarkdownViewer.spec.tsx
- convertRequestToSample.spec.ts.snap
- convertRequestToSample.spec.ts
- RequestSamples.test.tsx
- convertRequestToSample.ts
- extractCodeSamples.ts
- index.ts
- requestSampleConfigs.ts
- RequestSamples.stories.tsx
- RequestSamples.tsx
- ResponseExamples.spec.tsx
- ResponseExamples.stories.tsx
- ResponseExamples.tsx
- constants.ts
- index.ts
- TableOfContents.spec.tsx
- TableOfContents.stories.tsx
- TableOfContents.tsx
- types.ts
- utils.ts
- APIKeyAuth.tsx
- Auth.tsx
- authentication-utils.ts
- AuthTokenInput.tsx
- BasicAuth.tsx
- BearerAuth.tsx
- DigestAuth.tsx
- OAuth2Auth.tsx
- BinaryBody.test.tsx
- FormDataBody.test.tsx
- BinaryBody.tsx
- FormDataBody.tsx
- request-body-utils.ts
- RequestBody.tsx
- useTextRequestBodyState.ts
- mocking-utils.ts
- MockingButton.tsx
- useMockingOptions.ts
- parameter-utils.spec.ts
- FileUploadParameterEditors.tsx
- OperationParameters.tsx
- parameter-utils.spec.ts
- parameter-utils.ts
- ParameterEditor.tsx
- useOperationParameters.ts
- useLineCount.ts
- ReponseCodeViewer.tsx
- Response.spec.tsx
- Response.tsx
- ServersDropdown.tsx
- ServerVariables.tsx
- useServerVariables.ts
- VariableEditor.tsx
- build-request.spec.ts
- build-request.ts
- chosenServer.ts
- index.ts
- TryIt.spec.tsx
- TryIt.stories.tsx
- TryIt.tsx
- TryItWithRequestSamples.spec.tsx
- TryItWithRequestSamples.stories.tsx
- TryItWithRequestSamples.tsx
- LinkHeading.tsx
- LoadMore.tsx
- Logo.tsx
- NonIdealState.tsx
- PoweredByLink.tsx
- MockingProvider.tsx
- InlineRefResolver.spec.tsx
- InlineRefResolver.tsx
- Options.tsx
- Persistence.tsx
- RouterType.tsx
- utils.ts
- withMosaicProvider.spec.tsx
- withMosaicProvider.tsx
- withQueryClientProvider.spec.tsx
- withQueryClientProvider.tsx
- withRouter.tsx
- useBundleRefsIntoDocument.ts
- useFirstRender.ts
- useIsCompact.ts
- useParsedData.ts
- useParsedValue.ts
- useResponsiveLayout.tsx
- useRouter.tsx
- useUniqueId.ts
- securitySchemes.spec.ts
- exampleGeneration.spec.tsx
- exampleGeneration.ts
- IServer.spec.ts
- examples.ts
- IServer.ts
- persistAtom.ts
- security.spec.ts
- security.ts
- ReferenceResolver.ts
- resolvedObject.test.ts
- resolvedObject.ts
- chooseOption.ts
- fileToBase64.ts
- guards.ts
- headers.ts
- http.ts
- node.ts
- securitySchemes.ts
- string.ts
- createElementClass.ts
- constants.ts
- core.css
- index.ts
- styled.tsx
- styles.css
- types.ts
- jest.config.js
- LICENSE
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- main.js
- manager.js
- preview.jsx
- branches.json
- node-content.json
- table-of-contents.json
- BranchSelector.spec.tsx
- BranchSelector.stories.tsx
- BranchSelector.tsx
- index.tsx
- index.tsx
- index.tsx
- NodeContent.spec.tsx
- NodeContent.stories.tsx
- NodeContent.tsx
- index.tsx
- Search.stories.tsx
- Search.tsx
- SearchOverlay.tsx
- index.tsx
- TableOfContents.stories.tsx
- TableOfContents.tsx
- Forbidden.tsx
- Loading.tsx
- NotFound.tsx
- UpgradeToStarter.tsx
- StoplightProject.spec.tsx
- StoplightProject.stories.tsx
- StoplightProject.tsx
- getBranches.test.ts
- getNodeContent.test.ts
- getNodes.test.ts
- getTableOfContents.test.ts
- getWorkspace.test.ts
- getBranches.ts
- getNodeContent.ts
- getNodes.ts
- getTableOfContents.ts
- getWorkspace.ts
- dataFetching.spec.tsx
- useGetBranches.ts
- useGetNodeContent.ts
- useGetNodes.ts
- useGetTableOfContents.ts
- useGetWorkspace.tsx
- StoplightProject.stories.tsx
- components.ts
- index.ts
- consts.ts
- index.ts
- styles.css
- types.ts
- version.ts
- jest.config.js
- LICENSE
- package.json
- README.md
- tsconfig.build.json
- tsconfig.json
- web-components.config.js
- .babelrc.json
- .eslintrc.js
- .gitignore
- .prettierrc.js
- .stoplight.json
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- cypress.config.ts
- jest.config.js
- lerna.json
- LICENSE.md
- netlify.toml
- package.json
- postcss.config.js
- README.md
- setupTests.ts
- toc.json
- tsconfig.json
- use-local-elements.sh
- web-components.webpack.config.js
- weekly-lockfile-maintenance.sh
- yarn.lock
π Installation Guide
1. Get the code
git clone https://github.com/stoplightio/elements
Downloads the entire project code from GitHub to your computer.
cd elements
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
$ npm install @stoplight/elements
Downloads and installs the libraries listed in package.json.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)