docsify

mirror of https://github.com/docsifyjs/docsify.git synced 2026-01-18 15:13:00 +00:00

History

Joe Pea 136e666e78 Merge branch 'develop' into fix-validating-remote-content-2

* develop: (104 commits)
  chore: bump ssri from 6.0.1 to 6.0.2 (#1563)
  chore: Update Edit Document using develop branch (#1541)
  fix: Add escapeHtml for search (#1551)
  docs: link with plugin Pagination (#1554)
  fix: Upgrade dompurify from 2.2.6 to 2.2.7 (#1553)
  fix: upgrade dompurify from 2.2.6 to 2.2.7 (#1552)
  chore: bump y18n from 4.0.0 to 4.0.1 (#1548)
  chore: Fix search for missing pathNamespaces (#1547)
  fix: Upgrade docsify from 4.12.0 to 4.12.1 (#1544)
  docs:Update deploy, change Zeit to Vercel (#1540)
  fix: Cannot read property 'classList' of null (#1527)
  chore: fix microsoft/playwright-github-action error (#1534)
  Update PULL_REQUEST_TEMPLATE.md
  chore: Update CHANGELOG and Update test snapshots
  chore: add changelog 4.12.1
  [build] 4.12.1
  feat: Support search when there is no title (#1519)
  test(unit): add test cases on isExternal. (#1515)
  docs: Update Vercel logo link (#1520)
  fix: Upgrade docsify from 4.11.6 to 4.12.0 (#1518)
  ...

2021-05-04 01:59:38 -07:00

_images

docs(en) finish

2017-02-13 22:43:58 +08:00

_media

docs: add vercel logo (#1267 )

2020-07-04 16:02:16 +05:30

_coverpage.md

[build] 4.12.1

2021-03-07 11:00:41 +08:00

_navbar.md

Add label translations (ru, es)

2021-02-04 14:47:17 -06:00

_sidebar.md

chore(docs): remove new badege

2018-10-31 21:15:07 +08:00

.nojekyll

Add logo (#28 )

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

cdn.md

docs: update other cdn (#1325 )

2020-08-02 12:09:08 +08:00

CNAME

add docsify.js.org

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

configuration.md

docs: Updated alias (#1511 )

2021-02-15 09:48:00 +08:00

cover.md

docs: remove bundle size from the home page and documentation (#1257 )

2020-07-02 21:02:47 +05:30

custom-navbar.md

changed the CDN from unpkg to jsDelivr #1020 (#1022 )

2020-02-12 17:10:23 +05:30

deploy.md

docs:Update deploy, change Zeit to Vercel (#1540 )

2021-03-18 00:21:33 +08:00

embed-files.md

[Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313 )

2020-08-14 07:53:23 +08:00

helpers.md

docs: add crossOriginLinks configurations details. (#1386 )

2020-10-08 07:00:08 +08:00

index.html

chore: Update Edit Document using develop branch (#1541 )

2021-04-18 16:14:33 +08:00

language-highlight.md

Update language-highlight.md

2020-07-02 18:20:39 -05:00

markdown.md

docs: mermaid duplicated id, see #504 (#685 )

2018-11-06 17:27:24 +08:00

more-pages.md

fix: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318 )

2020-07-30 18:11:04 +08:00

plugins.md

docs: link with plugin Pagination (#1554 )

2021-04-11 21:02:11 +08:00

pwa.md

changed the CDN from unpkg to jsDelivr #1020 (#1022 )

2020-02-12 17:10:23 +05:30

quickstart.md

update(docs): update the cmd of python setup serve in py2 and py3. (#1473 )

2021-01-09 22:11:43 +08:00

README.md

docs: Update Vercel logo link (#1520 )

2021-02-20 15:54:30 +08:00

ssr.md

WIP: update use native Node ESM for server code, update config files to specifically use .cjs (those tools don't support Node ESM files yet), use a single eslintrc file, all test code uses ESM import/export syntax instead of require (WIP)

2021-05-04 00:08:36 -07:00

themes.md

fix: theme switcher in IE11 (#1502 )

2021-02-09 23:27:20 -06:00

vue.md

Update Vue-related descriptions and links

2020-11-19 15:42:51 -06:00

write-a-plugin.md

Fix typo in Edit Button example

2019-04-06 00:11:54 +10:00

README.md

docsify

A magical documentation site generator.

What it is

docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an index.html and deploy it on GitHub Pages.

See the Quick start guide for more details.

Features

No statically built html files
Simple and lightweight
Smart full-text search plugin
Multiple themes
Useful plugin API
Emoji support
Compatible with IE11
Support server-side rendering (example)

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.

Special Thanks

Vercel has given us a Pro account.