https://github.com/mbrn/libzy

A boilerplate to document a library
https://github.com/mbrn/libzy

documentation documentation-tool material-ui mdx reactjs

Last synced: about 1 month ago
JSON representation

A boilerplate to document a library

• Host: GitHub
• URL: https://github.com/mbrn/libzy
• Owner: mbrn
• Created: 2019-04-13T17:25:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T20:36:49.000Z (over 2 years ago)
• Last Synced: 2025-03-18T13:51:17.064Z (about 1 month ago)
• Topics: documentation, documentation-tool, material-ui, mdx, reactjs
• Language: JavaScript
• Homepage: https://mbrn.github.io/libzy
• Size: 2.65 MB
• Stars: 24
• Watchers: 1
• Forks: 2
• Open Issues: 28
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# libzy

[![Build Status](https://travis-ci.org/mbrn/libzy.svg?branch=master)](https://travis-ci.org/mbrn/libzy)

[![npm package](https://img.shields.io/npm/v/libzy-lib/latest.svg)](https://www.npmjs.com/package/libzy-lib)

[![NPM Downloads](https://img.shields.io/npm/dt/libzy-lib.svg?style=flat)](https://npmcharts.com/compare/libzy-lib?minimal=true)

[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/mbrn/libzy.svg)](http://isitmaintained.com/project/mbrn/libzy "Average time to resolve an issue")

[![Follow on Twitter](https://img.shields.io/twitter/follow/baranmehmet.svg?label=follow+baranmehmet)](https://twitter.com/baranmehmet)

Libzy is a boilerplate that makes documentation faster. It uses material-ui UI components.

## Key features

* Create project with libzy cli

* Markdown support

* MDX support

* react-live support

* Build ready

* Easy configurable

* and more

## Demo and documentation

You can access all examples and documentation from [__DOCS__](https://mbrn.github.io/libzy).

## Instal & Create Project

To install material-table with `npm`:

    npm install -g libzy

    libzy create

## License

This project is licensed under the terms of the [MIT license](/LICENSE).