mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00

History

Joe Pea b960519608

feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

This `new Docsify(opts)` API can be safely converted to a Custom Element constructor with backwards compatibility later.

2025-12-03 21:49:44 -08:00

_images

chore: remove sponsors section (#2544 )

2025-05-06 17:12:42 +08:00

_media

feat: v5 style overhaul (#2469 )

2024-07-19 15:34:51 +00:00

_coverpage.md

[release] 5.0.0-rc.3

2025-09-05 12:24:11 +08:00

_navbar.md

chore: retire outdate multiple languages and update it test snap (#2546 )

2025-05-06 17:08:57 +08:00

_sidebar.md

docs: update sidebar link formatting (#2577 )

2025-07-28 22:46:27 +08:00

.nojekyll

Add logo (#28 )

2016-12-18 15:30:50 +08:00

adding-pages.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

cdn.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

CNAME

add docsify.js.org

2016-11-28 12:22:47 +08:00

configuration.md

feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

2025-12-03 21:49:44 -08:00

cover.md

docs: changes in sync Chinese translation (#2548 )

2025-05-08 15:43:44 +08:00

custom-navbar.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

deploy.md

docs: add DeployHQ deployment instructions (#2627 )

2025-11-13 10:31:07 +08:00

embed-files.md

feat: Fragment identifier full line ignore (#2626 )

2025-11-24 10:47:19 +08:00

emoji.md

chore: Sync emoji data with GitHub emoji API (#2539 )

2025-04-19 08:37:28 +08:00

helpers.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

index.html

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

language-highlight.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

markdown.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

plugins.md

feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

2025-12-03 21:49:44 -08:00

pwa.md

docs: remove test pwa

2025-05-09 14:41:11 +08:00

quickstart.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

README.md

docs: Update intro paragraph to help improve first impressions and broaden audience (#2602 )

2025-09-28 10:43:05 +08:00

themes.md

fix: normalize slugs to NFC and remove emoji variation selector (#2597 )

2025-09-02 11:46:11 +08:00

ui-kit.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

vue.md

feat: GitHub style callouts (#2487 )

2025-09-01 12:53:59 +08:00

write-a-plugin.md

update: correct links and action to 'main' branch (#2547 )

2025-05-06 17:19:25 +08:00

README.md

docsify

A magical documentation site generator.

What it is

Docsify turns your Markdown files into a documentation website instantly. Unlike most other documentation site generator tools, it doesn't need to build HTML files. Instead, it dynamically loads and parses your Markdown files and displays them as a website. To get started, create an index.html file and deploy it on GitHub Pages (for more details see the Quick start guide).

Features

No statically built HTML files
Simple and lightweight
Smart full-text search plugin
Multiple themes
Useful plugin API
Emoji support

Examples

Check out the Showcase to see docsify in use.

Donate

Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me buy a cup of coffee. ❤️

Community

Users and the development team are usually in the Discord server.