GithubHelp home page GithubHelp logo

shinxi / docsify Goto Github PK

View Code? Open in Web Editor NEW

This project forked from docsifyjs/docsify

0.0 2.0 0.0 995 KB

๐Ÿƒ A magical documentation site generator.

Home Page: https://docsify.js.org

License: MIT License

JavaScript 87.96% HTML 0.47% CSS 11.57%

docsify's Introduction

docsify

A magical documentation site generator.

Travis Status npm donate

Links

Features

  • No statically built html files
  • Simple and lightweight (~16kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE10+

Quick start

Create a index.html.

<!-- index.html -->

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
  <div id="app"></div>
</body>
<script src="//unpkg.com/docsify"></script>
</html>

Browser Support

Modern browsers and Internet Explorer 10+.

Showcase

These open-source projects are using docsify to generate their sites. Pull requests welcome ๐Ÿ˜Š

  • Snipaste - Snip & Paste
  • puck - A small & magical php framework.
  • Samaritan - An Algorithmic Trading Framework for Digital Currency.
  • Vudash - Powerful, Flexible, Open Source dashboards for anything
  • Trilogy - No-hassle SQLite with a Promise-based, document store style API.
  • Mybatis-Plus - An enhanced toolkit of Mybatis to simplify development

Similar projects

  • docute - ๐Ÿ“œ Effortlessly documentation done right
  • docpress - Documentation website generator

Contributing

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

Development

npm i && npm run dev
open http://localhost:3000

License

MIT

docsify's People

Contributors

antony avatar gpresland avatar leopoldthecoder avatar liril-net avatar liulex avatar miaolz123 avatar nsina avatar playeryk avatar prayagverma avatar qingwei-li avatar reverland avatar woshiguabi avatar yangyang0507 avatar z-song avatar

Watchers

 avatar  avatar

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.