Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@docco/docco-wip

Package Overview
Dependencies
Maintainers
1
Versions
12
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@docco/docco-wip

Write code, not docs

  • 1.5.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Weekly downloads
 
Created
Source

Docco

Docco WIP


Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. API and props
  5. Roadmap
  6. Contribute
  7. License
  8. Contact
  9. Acknowledgements

About The Project 📝

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

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next.js
  • React

(back to top)


Getting Started 🚀

Pre-Requisites

  • Have installed yarn or npm
  • Node version >= 12

Installation

npm install --save docco-wip

Or with yarn:

yarn add docco-wip

(back to top)


Usage ✨

import Docco from '@docco/docco-wip';
import React from 'react';

    render() {
        return (
            <div id="docco">
                <Docco url="https://url-to-spec-file" />       
            </div>
            );
        }

In the interactive demo below, try changing the code and see how it affects the output.

Edit Button

(back to top)


API / Props 🧪

(back to top)


Roadmap 📍

  • [] Add MUI Theme to repository
  • [] Tools and processes
    • Rollup config
    • Codesandbox CI
    • Commit lint
    • [] Contribute Guide
    • [] Unit tests
    • [] Component tests
    • [] E2E test

(back to top)


Contribute and Feedback 🤝

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.

Code of Conduct

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.

Contributing Guide

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

(back to top)


License 🔒

MIT © Docco

(back to top)


Contact 👻

(back to top)


Acknowledgments 🙏

This project would not be possible without:

(back to top)

Keywords

FAQs

Package last updated on 15 Nov 2022

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc