docsify

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

History

Joe Pea 60ccf09086 initial SSR working independently without a seconds server

Many things work. What doesn't work (needs work):

- Any dynamic config options (f.e. any that use functions) need to be specified in the HTML by augmenting the injected config object. This includes plugins, Vue components, and similar.
- Plugins and Vue don't work on initial SSR render. Switch pages dynamically and they work during the dynamic markdown handling.
- Cover page causes an error
- Search plugin causes an error

2021-05-17 23:40:00 -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

initial SSR working independently without a seconds server

2021-05-17 23:40:00 -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.