Skip to content

/ docsify

🃏 A magical documentation site generator.
documentation documentation-tool github-pages docs docsify vue doc markdown
JavaScript CSS HTML Shell
  1. JavaScript 82.8%
  2. CSS 13.0%
  3. HTML 3.7%
  4. Shell 0.5%
Branch: develop
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

@anikethsaha
anikethsaha Merge pull request #1201 from docsifyjs/config-semantic 
ci: fixed semantic config
Latest commit 6026357 May 27, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ci: fixed semantic config May 27, 2020
.vscode chore: documented __colon__ tip (#1025) Feb 14, 2020
build
cypress Improve accessibility of viewport meta Apr 27, 2020
docs update: updated docs site dark and light mode with switch and redesig… May 22, 2020
packages/docsify-server-renderer fix: fixed target and rel issue (fixes #1183) May 20, 2020
src Fix: emoji +1 and -1 not rendering (#1187) May 23, 2020
test fix: fixed target and rel issue (fixes #1183) May 20, 2020
.eslintignore chore: added new linter config (#1028) Feb 20, 2020
.eslintrc.js chore: added new linter config (#1028) Feb 20, 2020
.gitignore [Test] : e2e tests using cypress (#999) Jan 30, 2020
.gitpod.yml [gitpod-setup] fix the preview opening issue. Mar 14, 2020
.npmignore update helper files Mar 18, 2017
.prettierrc.js chore: added new linter config (#1028) Feb 20, 2020
CHANGELOG.md chore: add changelog 4.11.3 Mar 25, 2020
CONTRIBUTING.md chore: Activating Open Collective (#367) Feb 11, 2018
HISTORY.md Fix typos (#326) Dec 16, 2017
LICENSE Update LICENSE Dec 26, 2017
README.md [gitpod-setup] fix the preview opening issue. Mar 14, 2020
cypress.json [Test] : e2e tests using cypress (#999) Jan 30, 2020
index.html Merge pull request #1152 from sy-records/fix-edit-on-github May 7, 2020
lerna.json add lerna May 31, 2017
package-lock.json chore: updated dep and docs Mar 25, 2020
package.json v4.11.3 Mar 24, 2020
server.js Improve accessibility of viewport meta Apr 27, 2020

README.md

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suites npm donate gitter Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Links

Features

  • No statically built html files
  • Simple and lightweight (~21kB gzipped)
  • 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 😊

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

You can’t perform that action at this time.