iotcat
/
docsify
mirror of https://github.com/IoTcat/docsify.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1069 Commits
6 Branches
177 Tags
3.3 MiB
 
 
 
 
Tag: Branch: Tree: master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
docsify/docs
Anton Wilhelm f74b53f53e
Merge pull request #733 from jthegedus/master 		5 years ago
..
_images docs(en) finish 7 years ago
_media feat: Provide code fragments feature (#748) 5 years ago
.nojekyll Add logo (#28) 7 years ago
CNAME add docsify.js.org 8 years ago
README.md chore: update file size 6 years ago
_coverpage.md [build] 4.9.1 5 years ago
_navbar.md chore: add ru and es docs 6 years ago
_sidebar.md chore(docs): remove new badege 6 years ago
cdn.md Update cdn.md (#479) 6 years ago
configuration.md feat: allows relative path, fixed #590 5 years ago
cover.md chore: update file size 6 years ago
custom-navbar.md docs: add mutiple covers 6 years ago
deploy.md Docsify publishing with AWS Amplify steps 5 years ago
embed-files.md feat: Provide code fragments feature (#748) 5 years ago
helpers.md docs(helper): about markdown in html tag, fixed #655 fixed #667 6 years ago
index.html chore: add gitter sidecar 6 years ago
language-highlight.md Update language-highlight.md (#277) 7 years ago
markdown.md docs: mermaid duplicated id, see #504 (#685) 6 years ago
more-pages.md document customising page title with sidebar 5 years ago
plugins.md feat(search-plugin): add namespace option (#706) 5 years ago
pwa.md update english docs 7 years ago
quickstart.md chore: update german docs, fix links (#560) 6 years ago
ssr.md fix error in ssr config example 5 years ago
themes.md chore: update german docs, fix links (#560) 6 years ago
vue.md [docs][vue-demo][minor] add ID in div element (#506) 6 years ago
write-a-plugin.md Fix typo in Edit Button example 5 years ago

README.md
Escape

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 IE10+
  • 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.