archive-gh-me/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00
Code Issues Projects Releases Wiki Activity
1,688 Commits 28 Branches 197 Tags
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
dependabot[bot] 2a996f1c65
chore: bump browser-sync from 2.29.1 to 2.29.3 (#2075) 
Bumps [browser-sync](https://github.com/BrowserSync/browser-sync) from 2.29.1 to 2.29.3.
- [Release notes](https://github.com/BrowserSync/browser-sync/releases)
- [Changelog](https://github.com/BrowserSync/browser-sync/blob/master/CHANGELOG.md)
- [Commits](https://github.com/BrowserSync/browser-sync/compare/v2.29.1...v2.29.3)

---
updated-dependencies:
- dependency-name: browser-sync
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-05-26 17:18:13 +08:00
.codesandbox
feat: Native emoji w/ image-based fallbacks and improved parsing (#1746)
2022-03-05 22:25:09 -06:00
.github
chore: bump actions/setup-node from 2 to 3 (#2027)
2023-04-18 16:15:14 +08:00
.vscode
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
build
feat: Emoji build (#1766)
2022-03-08 16:22:10 +08:00
docs
chore(docs): docsify-ignore config polish. (#1994)
2023-02-23 16:01:11 +08:00
packages/docsify-server-renderer
chore: bump node-fetch from 2.6.9 to 3.3.1 (#2064)
2023-05-15 15:41:14 +08:00
src
Fix the end condition for the embed content handling loop (#1824)
2023-05-18 14:13:56 +08:00
test
fix: fix id with pure number. (#2021)
2023-04-22 17:53:17 +08:00
.editorconfig
add editorconfig (tells editors which basic text format to use)
2020-05-22 01:29:36 -07:00
.eslintignore
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
.eslintrc.js
Virtual Routes Support (#1799)
2022-05-23 14:03:33 -07:00
.gitignore
fix: Coverpage when content > viewport height (#1744)
2022-02-03 16:03:34 -06:00
.gitpod.yml
[gitpod-setup] fix the preview opening issue.
2020-03-14 07:31:11 +00:00
.npmignore
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
.prettierrc.js
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
babel.config.js
Jest + Playwright Testing (#1276)
2020-10-05 14:10:30 -05:00
CHANGELOG.md
chore: add changelog v4.13.0
2022-10-26 21:50:32 +08:00
CONTRIBUTING.md
chore: Update CONTRIBUTING.md (#1782)
2022-03-31 16:28:32 +08:00
Dockerfile
test:docker locally.
2021-12-10 01:55:30 +08:00
HISTORY.md
Fix typos (#326)
2017-12-16 12:06:12 +08:00
index.html
docs: Fix missing dolphin theme (#1960)
2023-01-10 16:02:02 +08:00
jest.config.js
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
lerna.json
add lerna
2017-05-31 10:01:15 +08:00
LICENSE
Update LICENSE
2022-01-16 19:52:18 -08:00
package-lock.json
chore: bump browser-sync from 2.29.1 to 2.29.3 (#2075)
2023-05-26 17:18:13 +08:00
package.json
chore: bump eslint-plugin-playwright from 0.8.0 to 0.12.0 (#2060)
2023-05-23 19:52:31 +08:00
playwright.config.js
refactor: Update test environments and lint configuration (#1736)
2022-01-30 21:40:21 -06:00
README.md
Improve README.md sentence (#1817)
2022-06-06 22:12:47 -07:00
sandbox.config.json
feat: Native emoji w/ image-based fallbacks and improved parsing (#1746)
2022-03-05 22:25:09 -06:00
SECURITY.md
Create SECURITY.md (#1634)
2021-09-10 13:57:38 +08:00
server.js
Improve accessibility of viewport meta
2020-04-27 21:47:49 +01:00

README.md

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 😊

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

Description
🃏 A magical documentation site generator.
Readme MIT 70 MiB
Languages
JavaScript 86.8%
CSS 12.5%
TypeScript 0.3%
Shell 0.2%
HTML 0.2%