GithubHelp home page GithubHelp logo

shreekrishnaacharya / docit Goto Github PK

View Code? Open in Web Editor NEW

This project forked from blizzbolts/docit

0.0 0.0 0.0 5.46 MB

Rapid React Documentation

Home Page: https://blizzbolts.github.io/docit

License: MIT License

JavaScript 1.20% HTML 0.42% TypeScript 98.38%

docit's Introduction

This Project is still under development. Use with caution.

Docit

Download Node Version Vite Verson

Simple and Rapid React Documentation https://blizzbolts.github.io/docit

  • 😛 MDX & MD Syntax oriented.
  • 🌪️ Fast HMR
  • 💹 Out of the Box Api & Component Props Table Generation
  • ❤️ Emoji Support and Responsive Designs

Get Started

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

yarn add @blizzbolts/docit -D

Usage

  1. Make your first markdown file under docs
mkdir docs

echo "# Introudction" > docs/index.md
  1. Start your doc local dev server by
docit start

For build

docit build

Credits

This project is inspired by Vitepress and Storybook, powered by Vite and MDX

Changelog

CHANGELOG.md

Examples

Docit

Screenshot

image

docit's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.