From 319240cf9c92da3955d439040fa109ced8628b92 Mon Sep 17 00:00:00 2001 From: BIKSHA _chowdary15 Date: Thu, 22 May 2025 15:54:52 +0530 Subject: [PATCH] Update README.md --- README.md | 97 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 60 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 31d759d34..f30be52b2 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,18 @@

- docsify + Docsify

-

- A magical documentation site generator. -

+

Docsify

+

A magical documentation site generator.

Backers on Open Collective - - Sponsors on Open Collective + Sponsors on Open Collective Build & Test npm - Join Discord community and chat about Docsify + Join Discord community Gitpod Ready-to-Code

@@ -26,58 +24,83 @@

-Docsify turns one or more Markdown files into a Website, with no build process required. +--- + +## 📝 What is Docsify? + +> **Docsify** turns one or more Markdown files into a documentation website — no static site generator build step required. -## Features +--- -- No statically built html files -- Simple and lightweight -- Smart full-text search plugin +## 🚀 Features + +- No build step or static HTML generation +- Loads Markdown files on demand +- Full-text search plugin - Multiple themes -- Useful plugin API -- Emoji support +- Plugin API support +- Emoji support 🎉 + +--- + +## ⚡ Quick Start + +Use the ready-to-go [Docsify Template](https://github.com/docsifyjs/docsify-template), or try it instantly in CodeSandbox: -## Quick Start +[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) -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. +Or review the [quick start tutorial](https://docsify.js.org/#/quickstart). -[![Edit 307qqv236](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/307qqv236) +--- -## Showcase +## 🌟 Showcase -A large collection of showcase projects are included in [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase). +Explore example sites built with Docsify in the [awesome-docsify](https://github.com/docsifyjs/awesome-docsify#showcase) collection. -## 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) +## 🔗 Useful Links -## Contributing +- [📚 Documentation](https://docsify.js.org) +- [📦 Docsify CLI](https://github.com/docsifyjs/docsify-cli) +- [📡 CDN Links](https://unpkg.com/docsify/) | [jsDelivr](https://cdn.jsdelivr.net/npm/docsify/) | [cdnjs](https://cdnjs.com/libraries/docsify) +- [`develop` branch live preview](https://docsify-preview.vercel.app/) +- [Awesome Docsify List](https://github.com/docsifyjs/awesome-docsify) +- [💬 Community Chat (Discord)](https://discord.gg/3NwKFyR) -See [CONTRIBUTING.md](CONTRIBUTING.md). +--- -## Backers +## 🤝 Contributing -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/docsify/contribute)] +See [CONTRIBUTING.md](CONTRIBUTING.md) for how to help. - +--- -## Sponsors +## 💖 Backers -Thank you for supporting this project! ❤️ [[Become a sponsor](https://opencollective.com/docsify/contribute)] +Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/docsify/contribute) + + + +--- + +## 💎 Sponsors + +[Become a sponsor](https://opencollective.com/docsify/contribute) -## Contributors +--- -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. +## 👥 Contributors + +This project exists thanks to all the people who contribute. [Contribute](CONTRIBUTING.md) -## License +--- + +## 📄 License + +[MIT License](LICENSE) -[MIT](LICENSE)