docsify

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

History

fix: Updated docs with instructions for installing specific version (fixes #780 ) (#1225 )

* feat: Updated docs with instructions for installing specific version

* Removed path and name from script tag

* Updated stylesheet with specific version

* Formatted and organized headings and html blocks for version specification

* Removed html block for latest version

2020-06-23 22:41:20 +05:30

_images

docs(en) finish

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

_media

Add front matter to dev page

2020-04-27 12:24:24 -07:00

_coverpage.md

[build] 4.11.4

2020-06-18 23:46:39 +05:30

_navbar.md

chore: add ru and es docs

2018-07-01 19:46:46 +08: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

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

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

CNAME

add docsify.js.org

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

configuration.md

Merge branch 'develop' into allow-config-function

2020-06-07 14:10:57 -07:00

cover.md

Update cover.md (#1134 )

2020-04-23 15:16:58 +05:30

custom-navbar.md

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

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

deploy.md

[documdocs: deploy docsify in docker. (#1241 )

2020-06-23 12:41:31 +05:30

embed-files.md

docs: Add embed gist instructions to Embed Files (fixes #932 ) (#1238 )

2020-06-22 23:10:26 +05:30

helpers.md

fix: cross-origin url cannot be redirected when "externalLinkTarget" is set to "_self" and "routerMode" is set to "history". (#1062 )

2020-05-15 11:00:36 +05:30

index.html

Revert "Updated docs site dark and light mode with switch and redesigned search bar using docsify-darklight-theme" (#1207 )

2020-06-09 22:02:30 +05:30

language-highlight.md

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

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

markdown.md

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

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

more-pages.md

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

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

plugins.md

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

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

pwa.md

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

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

quickstart.md

fix: Updated docs with instructions for installing specific version (fixes #780 ) (#1225 )

2020-06-23 22:41:20 +05:30

README.md

Readme: Improve outdated links to showcase

2019-05-05 18:50:31 +02:00

ssr.md

Improve accessibility of viewport meta

2020-04-27 21:47:49 +01:00

themes.md

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

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

vue.md

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

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

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 (~21kB gzipped)
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 Gitter chat room.