docsify

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

History

Sytone b05949a161 Add front matter to dev page

Update embeded files documentation
Add example with front matter
Add various comments I used to understand code
Updated front matter to have installed flag
Added function to parse front matter
Added intercept to remove front matter for embed

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

_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

chore: updated dep and docs

2020-03-25 13:35:34 +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

Update nameLink option docs (#1125 )

2020-04-19 21:02:07 +05:30

cover.md

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

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

custom-navbar.md

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

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

deploy.md

Added a redirect for images to show up in Amplify (#918 )

2019-12-20 17:42:53 +05:30

embed-files.md

Add front matter to dev page

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

helpers.md

fix: emojis in titles not working correctly and update (#1016 )

2020-02-14 12:51:07 +05:30

index.html

feat: added dark mode to docs closes #1031

2020-02-23 12:34:15 +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

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

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

README.md

Readme: Improve outdated links to showcase

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

ssr.md

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

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

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.