Github url

docsify

by docsifyjs

docsifyjs /docsify

πŸƒ A magical documentation site generator.

14.2K Stars 3.4K Forks Last release: 18 days ago (v4.11.4) MIT License 1.3K Commits 186 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

docsify

A magical documentation site generator.

Backers on Open CollectiveSponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suitesnpmdonategitterGitpod Ready-to-Code

Gold Sponsor via Open Collective

Links

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE11
  • Support SSR (example)
  • Support embedded files

Quick start

Look at this tutorial

Edit 307qqv236

Showcase

These projects are using docsify to generate their sites. Pull requests welcome :blush:

Move to awesome-docsify

Similar projects

| Project | Description | | ------------------------------------------------ | ---------------------------------------- | | docute | πŸ“œ Effortlessly documentation done right | | docpress | Documentation website generator |

Contributing

Online one-click setup for Contributing

You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:

  • clone the docsify repo.
  • install the dependencies.
  • start
    npm run dev
    .

So that you can start straight away.

Open in Gitpod

  • 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 run bootstrap && npm run dev

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

Special Thanks

Vercel has given us a Pro account.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.