https://github.com/kazuma512/docsify
Docsify is a lightweight documentation tool for creating beautiful and interactive websites from markdown files. With Docsify, you can easily create a clean and organized documentation site for your project or product.
https://github.com/kazuma512/docsify
css docs-generator docsify firebase html html5 javascript kazuma512 npm
Last synced: 2 months ago
JSON representation
Docsify is a lightweight documentation tool for creating beautiful and interactive websites from markdown files. With Docsify, you can easily create a clean and organized documentation site for your project or product.
- Host: GitHub
- URL: https://github.com/kazuma512/docsify
- Owner: kazuma512
- License: mit
- Created: 2023-06-06T01:25:36.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-19T13:05:11.000Z (about 3 years ago)
- Last Synced: 2025-04-13T10:31:07.136Z (about 1 year ago)
- Topics: css, docs-generator, docsify, firebase, html, html5, javascript, kazuma512, npm
- Language: JavaScript
- Homepage: https://docsify.js.org/#/quickstart
- Size: 1.11 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
A magical documentation site generator.
## Links
- [Documentation](https://docsify.js.org)
- [CLI](https://github.com/QingWei-Li/docsify-cli)
## 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 an `index.html`.
```html
```
## Browser Support
Modern browsers and Internet Explorer 10+.
## Showcase
These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
| Project | Description |
|---|---|
| [Snipaste](https://docs.snipaste.com/) | Snip & Paste |
| [puck](https://puck.zz173.com/) | A small & magical php framework. |
| [Samaritan](http://samaritan.stockdb.org) | An Algorithmic Trading Framework for Digital Currency. |
| [Vudash](http://vudash.github.io/vudash/) | Powerful, Flexible, Open Source dashboards for anything |
| [Trilogy](http://trilogy.js.org) | No-hassle SQLite with a Promise-based, document store style API. |
| [Mybatis-Plus](http://mp.baomidou.com/) | An enhanced toolkit of Mybatis to simplify development |
| [JS MythBusters](https://mythbusters.js.org) | An optimization handbook from a high level point of view. |
| [hire-me](https://fvcproductions.github.io/hire-me) | A path to getting an awesome tech gig. |
| [vue-amap](https://elemefe.github.io/vue-amap/) | A Map Component Library Base on Vue 2.x and Gaode Map. |
## Similar projects
| Project | Description |
|---|---|
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
| [docpress](https://github.com/docpress/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
```bash
npm i && npm run dev
open http://localhost:3000
```
## License
MIT