[{"_1":2,"_160":-5,"_161":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_139":140},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_128":-5,"_129":11,"_130":21,"_131":11,"_132":-5,"_133":11,"_134":-5,"_135":136,"_137":91,"_138":-7},"canonicalUrl","https://hub.docker.com/r/dawneve/docsify/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","dawneve","reponame","docsify","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2022-07-25T11:31:42.220702Z","description","","is_private","last_updated","2022-07-25T11:31:42.277769Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",331,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# Versions\n\n```\n$ docker run -it -d --name docsify -p 8003:3000 -v /data/wangjl/test/docsify:/home/tom/docsify node bash\n$ docker exec -it docsify bash\nroot@ce05b2382081:/# node --version\nv17.3.0\nroot@ce05b2382081:/# npm --version\n8.3.0\n\n# docsify --version\n\ndocsify-cli version:\n 4.4.4\n```\n\n\n# How to use?\n```\nInit the docs\n# cd /home/tom/docsify/\n# docsify init docs\n\ncheck the files\n# ls -ltha docs/\ntotal 16K\ndrwxr-xr-x 2 root root 4.0K Jul 25 07:37 .\ndrwxrwxr-x 3 1001 1001 4.0K Jul 25 07:37 ..\n-rw-r--r-- 1 root root 604 Jul 25 07:37 index.html #入口文件\n-rw-r--r-- 1 root root 34 Jul 25 07:34 README.md #会做为主页内容渲染\n-rw-r--r-- 1 root root 0 Jul 25 07:34 .nojekyll #用于阻止 GitHub Pages 会忽略掉下划线开头的文件\n\n\nStart the server on port 3000:\n# docsify serve docs\n\n\nView from broser:\nhttp://IP:8003\n```\n\n\n\n\n# More details\n\n## How to make this book?\nUsing `docsify` to view markdown files.\n\nThe app has Dockered in `dawneve/docsify:4.4.4`.\n\n\n\n### (1) Start the environment in Docker\n\n```\n$ docker pull dawneve/docsify:4.4.4\n\n$ docker run -it -d --name docsify -p 8003:3000 -v /home/wangjl/data/project/learnCpp:/home/docsify/learnCpp dawneve/docsify:4.4.4 bash\n$ docker exec -it docsify bash\n\nInit the docs\n# cd /home/docsify/learnCpp\n# docsify init docs\nyes.\n\nStart the server on port 3000:\n# docsify serve docs\n\nBrowser on host:\nhttp://192.168.2.120:8003/#/\n```\n\n\n\n### (2) add new user in containner\n\n```\n$ id #check your uid on host\nuid=1001(wangjl) gid=1001(wangjl) groups=1001(wangjl),1004(docker) \n\nI added a user named tom when making this image:\nif(0){\n\t# useradd -s /bin/bash -d /home/docsify -m docsify -u 1001\n\t# passwd docsify\n\t# chown -R docsify /home/docsify\n}\n\nChange the uid of user tom in the containner to your id on the host as shown above.\n# usermod -u 1001 tom\n\nChange owner of these files in the containner\n# chown -R tom *\n\n\nStart the server on port 3000/ host 8003\n# docsify serve docs\n```\n\nThen we can:\n* Editing while viewing\n* Then we can edit md files on the host with VIM or other text editer like vsCode through ssh.\n\n\n\n\n\n\n### (3) add side bar\n```\n$ cd docs/\n$ vim index.html\n \n\n$ vim _sidebar.md\n* [Chapter 0 Preface](A0/1_readme.md)\n* [Chapter 1 Basics](A1/1_readme.md)\n* [Chapter 2 Class](A2/1_readme.md)\n```\n\nControl the sub menu shown level:\n```\n\n```\n\n\nOverwrite _sidebar.md in nested folds:\n```\n\n```\n\n\n\n\n\n### (4) add top menu\n\nWhen the menu are very few, just edit index.html\n```\n\n \n\n```\n\nAnother better way:\n```\n\n\n\n$ vim _navbar.md\n* [Basic](A1/1_readme)\n* [Class](A2/1_readme)\n* Help\n\t* [README](README)\n\t* [Editing Guid](A0/1_readme)\n```\n\n\n\n\n### (5) add cover\n\nDefault cover is ./README.md, but we can add one.\n\n```\n\n\n$ vim _coverpage.md\n![logo](images/logo/icon.svg)\n# My C++ docs\n## 个人文档网站\n> 一个神奇的文档网站生成工具 docsify\n* Simple and lightweight (~12kb gzipped)\n* Multiple themes\n* Not build static html files\n\n[GitHub](https://github.com/DawnEve/learn_C)\n[Get Started](/A0/1_readme)\n```\n\n\n\n### (6) save source files to local\n\nSave css and js to local, prevant loading…… problem.\n\n```\n$ vim index.html\n\n\n\n$ mkdir static\n$ mkdir static/css\n$ mkdir static/js\n\nSave the css and js files.\n$ wget https://cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css -O static/css/vue.css\n$ wget https://cdn.jsdelivr.net/npm/docsify@4 -O static/js/docsify.min.js\n```\n\n\n\n### (7) Other tips\n\n> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore.\n\n\n\n\n### (8) Push to github\n\n```\n$ git remote add origin https://github.com/DawnEve/learnCpp.git\nhttp/https 不能用了。\n$ git remote add origin git@eve:DawnEve/learnCpp.git \nfatal: remote origin already exists. \n\n$ git remote rm origin\n\nI am using multiple username on one machine.\n$ git remote add origin git@eve:DawnEve/learnCpp.git\n$ git push origin master\n```\n\n\n\n\n### Refer\n\n- https://docsify.js.org/#/?id=docsify\n- https://github.com/docsifyjs/docsify/blob/develop/docs/_sidebar.md\n- https://jingping-ye.github.io/docsify-docs-zh/#/\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",376431609,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},"content_type","creator",675124,"digest","sha256:7d5a7a9293195ab8b07fb4b35b5f7c684140649f20beba5618e940f119736b10","full_size",376421545,"id",259780959,"images",[103],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":98,"_63":66,"_116":-5},"architecture","amd64","features","last_pulled","2026-09-28T17:32:17.747437348Z","last_pushed","2022-07-25T11:31:43Z","os","linux","os_features","os_version","size","variant","2022-07-25T11:31:42.255347Z","last_updater","last_updater_username","media_type","4.4.4","repository",17667651,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":141,"_148":149,"_135":158,"_159":11},{"_40":142,"_42":143,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":144,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":145,"_79":11,"_80":147,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":146},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_150":64,"_151":-5,"_152":-5,"_153":154},"count","next","previous","results",[155],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_101":156,"_50":117,"_118":94,"_119":33,"_120":56,"_57":121,"_122":123,"_124":108,"_125":117,"_126":66,"_127":21},[157],{"_104":105,"_95":96,"_106":48,"_107":108,"_109":110,"_111":112,"_113":48,"_114":-5,"_115":98,"_63":66,"_116":-5},[],"canDeleteTags","actionData","errors"]

dawneve/docsify

Tags for dawneve/docsify