MCPcopy
hub / github.com/docsifyjs/docsify

github.com/docsifyjs/docsify @v4.13.1 sqlite

repository ↗ · DeepWiki ↗ · release v4.13.1 ↗
256 symbols 589 edges 97 files 20 documented · 8%
README

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm donate Join Discord community and chat about Docsify Gitpod 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
  • Experimental SSR support (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 a 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 add . && git commit -m '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

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

Core symbols most depended-on inside this repo

docsifyInit
called by 56
test/helpers/docsify-init.js
isExternal
called by 14
src/core/util/core.js
toURL
called by 12
src/core/router/history/base.js
next
called by 11
src/core/virtual-routes/next.js
removeAtag
called by 11
src/core/render/utils.js
getFile
called by 10
src/core/router/history/base.js
getCurrentPath
called by 10
src/core/router/history/base.js
getAndRemoveConfig
called by 9
src/core/render/utils.js

Shape

Function 157
Method 71
Class 28

Languages

TypeScript100%

Modules by API surface

src/core/fetch/index.js18 symbols
src/core/render/index.js17 symbols
src/core/render/compiler.js17 symbols
src/core/router/history/base.js12 symbols
src/plugins/search/search.js11 symbols
src/core/util/dom.js11 symbols
packages/docsify-server-renderer/index.js11 symbols
src/plugins/front-matter/yaml.js10 symbols
src/core/router/history/hash.js10 symbols
src/plugins/search/component.js9 symbols
src/core/virtual-routes/index.js7 symbols
src/core/router/index.js6 symbols

Used by 2 indexed graphs manifest dependencies, hub-wide

github.com/SurviveSJTU/SJTU-Application
github.com/ccxt/ccxt

Dependencies from manifests, versioned

@babel/core7.11.6 · 1×
@babel/eslint-parser7.16.5 · 1×
@babel/preset-env7.11.5 · 1×
@playwright/test1.18.1 · 1×
autoprefixer-stylus1.0.0 · 1×
axios0.21.1 · 1×
babel-jest27.4.6 · 1×
browser-sync2.26.12 · 1×
chokidar3.4.2 · 1×
common-tags1.8.0 · 1×
conventional-changelog-cli2.1.0 · 1×
copy-dir1.2.0 · 1×

For agents

$ claude mcp add docsify \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact