Docsify 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.
Install
Initialize
index.html
as the entry file.
Readme.md
as the home page.
.nojekyll
prevents the GitHub Page from ignoring files that begin with an underscore.
A basic configuration
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 <!DOCTYPE html > <html lang ="en" > <head > <meta charset ="UTF-8" > <title > 神奇的docsify</title > <meta http-equiv ="X-UA-Compatible" content ="IE=edge,chrome=1" /> <link rel ="icon" href ="/favicon.ico" type ="image/x-icon" /> <link rel ="shortcut icon" href ="/favicon.ico" type ="image/x-icon" /> <meta name ="description" content ="Description" > <meta name ="viewport" content ="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" > <link rel ="stylesheet" href ="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css" > </head > <body > <div id ="app" > 加载中...</div > <script > window .$docsify = { name : 'docsify-demo' , repo : 'https://github.com/zjcscut/docsify-demo' , loadSidebar : true , loadNavbar : true , coverpage : true , maxLevel : 4 , subMaxLevel : 2 } </script > <script > window .$docsify = { search : { maxAge : 86400000 , paths : auto, placeholder : '搜索' , noData : '找不到结果' , depth : 4 , hideOtherSidebarContent : false , namespace : 'docsify-demo' , } } </script > <script src ="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js" > </script > <script src ="//cdn.jsdelivr.net/npm/docsify/lib/plugins/emoji.min.js" > </script > <script src ="//cdn.jsdelivr.net/npm/docsify/lib/plugins/zoom-image.min.js" > </script > <script src ="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js" > </script > </body > </html >
Component
File
Sidebar
_sidebar.md
Navicat
_navbar.md
Cover
_coverpage.md
References Official
使用开源文档工具docsify,用写博客的姿势写文档