Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/docsifyjs/docsify

๐Ÿƒ A magical documentation site generator.
https://github.com/docsifyjs/docsify

doc docs docsify documentation documentation-tool github-pages markdown vue

Last synced: 11 days ago
JSON representation

๐Ÿƒ A magical documentation site generator.

Awesome Lists containing this project

README

        



docsify


A magical documentation site generator.


Backers on Open Collective

Sponsors on Open Collective

Build & Test
npm
Join Discord community and chat about Docsify
Gitpod Ready-to-Code

Gold Sponsor via Open Collective





Docsify turns one or more Markdown files into a Website, with no build process required.

## Features

- No statically built html files
- Simple and lightweight
- Smart full-text search plugin
- Multiple themes
- Useful plugin API
- Emoji support

## Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use [Docsify Template](https://github.com/docsifyjs/docsify-template), review the [quick start tutorial](https://docsify.js.org/#/quickstart) or jump right into a CodeSandbox example site with the button below.

[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236)

## Showcase

A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase).

## Links

- [Documentation](https://docsify.js.org)
- [Docsify CLI (Command Line Interface)](https://github.com/docsifyjs/docsify-cli)
- CDN: [UNPKG](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify)
- [`develop` branch preview](https://docsify-preview.vercel.app/)
- [Awesome docsify](https://github.com/docsifyjs/awesome-docsify)
- [Community chat](https://discord.gg/3NwKFyR)

## Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

## Backers

Thank you to all our backers! ๐Ÿ™ [[Become a backer](https://opencollective.com/docsify/contribute)]

## Sponsors

Thank you for supporting this project! โค๏ธ [[Become a sponsor](https://opencollective.com/docsify/contribute)]

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

## License

[MIT](LICENSE)

## Special Thanks

A preview of Docsify's PR and develop branch is Powered by Vercel