Table of Contents
Docco is the no code tool that with a few clicks will boost your company documentation. We understand how important it is to build a product, that is why we help companies transform their API specs into products that will facilitate the integration of customers.
Our mission is to transform documentation into products without any effort. Nowadays all the companies need to provide endpoints that other companies can integrate with. One of the biggest problems is that the documentation provided for companies to integrate with those endpoints is inaccurate, outdated, unclear and can lead to confusion and even frustration from the customers. Docco is here to avoid all that, with just a few clicks, all the documentation will be ready to be consumed
- Have installed yarn or npm
- Node version >= 16
npm install --save doccoOr with yarn:
yarn add doccoimport Docco from '@docco/docco';
import React from 'react';
export default function App() {
return (
<div className='App'>
<Docco url='https://api.docco.io/openapi.json' />
</div>
);
}In the interactive demo below, try changing the code and see how it affects the output.
Directory examples contains examples of how to use Docco component
| Demo | Usage | Description |
|---|---|---|
| Angular demo | Angular | Demo for Angular component. Run npm run start to start demo. |
| React demo | React | Demo for React component. Run npm run start to start demo. |
| Standalone demo | HTML | Demo for Standalone component. Run npm run start to start demo. |
| Vanilla demo | HTML | Demo for Vanilla component. Run npm run start to start demo. |
| Vue demo | Vue | Demo for Vue component. Run npm run serve to start demo. |
| Web Component demo | HTML | Demo for Web component. Run npm run start to start demo. |
export interface Props {
url: string;
theme?: 'light' | 'dark';
}- url: Url where the open api spec is located. For example: https://petstore.swagger.io/v2/swagger.json
- theme: Will set the docs theme. For now we support light and dark. The goal of this property is to receive a config object to make the look and feeling of the documentation customizable per organization
- [O] MVP Version of Docco
- [O] Docco v2
- [🤫😶] Stay tuned
We understand that the union make force. That is why we are grateful to the community for contributing with bugfixes and improvments. The main purpose of this repository is to continue evolving Docco, making it faster and easier to use. Development of Docco happens in the open on GitHub. Read below to learn how you can take part in improving Docco.
Docco has adopted the Contributor Covenant as its Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Docco.
- This repo is under active development. If you have any improvements / suggestions please file an issue or send in a Pull Request
- The issues page is a good place to visit if you want to pick up some task. It has a list of things that are to be implemented in the near future
MIT © Docco
This project would not be possible without:
