网站seo优化_亚洲九色_seo云优化_亚洲九九九_搜索引擎seo_亚洲九九精品_启新网络服务中心

企億推信息網
專注網絡推廣服務

如何使用docsify和GitHub頁面創建文檔網站?

如何自己創建網站?文檔是幫助用戶使用開源項目的一個重要部分,但它并不總是開發人員的首要任務,因為他們可能更關心如何使他們的應用程序更好地使用它。這就是為什么開發人員可以更容易地發布文檔。在本教程中,我將向您展示一種方法:如何自己創建網站。

如何使用docsify和GitHub頁面創建文檔網站?

默認情況下,githubpages會提示用戶使用Jekyll,一個支持HTML、CSS和其他web技術的靜態網站生成器。Jekyll可以從以降價格式編碼的文檔文件生成一個靜態網站,GitHub將自動識別它們。MD或。降價擴展。這是一個很好的設置,但我想試試別的。

幸運的是,githubpages支持HTML文件,這意味著您可以使用docsify等其他站點生成工具在這個平臺上創建一個網站。Docsify是一個擁有MIT許可證的開源項目,它可以很容易地在githubpages上創建一個有吸引力的***文檔網站。

文件

安裝docsify有兩種方法:

Docsify推薦NPM,但我將使用第二個選項。如果要使用NPM,請按照快速入門指南中的說明進行操作。

我已經在項目的GitHub頁面上發布了這個示例的源代碼。您可以單獨下載這些文件,也可以通過以下方式克隆存儲庫。

然后CD進入docsifydemo目錄。

如果您克隆我的GitHub存儲庫并切換到docsifydemo目錄,您應該會看到以下文件結構:

文件內容包含在ClonedWithub中

這基本上只是一個普通的HTML文件,但是看看這兩行:

這些行使用內容交付網絡(CDN)的URL來提供CSS和JavaScript腳本來將站點轉換為docsify站點。只要包含這些行,就可以將常規GitHub頁面轉換為文檔頁面。

body標記后的***行指定要呈現的內容:

Docsify使用單頁應用程序(SPA)呈現請求的頁面,而不是刷新新頁面。

***,查看腳本塊中的行:

在此區塊中:

您可以在docsify文檔的配置部分找到所有選項。

它使用markdown的鏈接格式來創建導航。請注意,tomcat、cloud和Java等鏈接是縮進的;這意味著它們在父鏈接下呈現為子鏈接。

圖像自述文件.md像和圖像這樣的文件與存儲庫的結構有關,但所有其他的降價文件都與docsify網頁相關。

根據您的需要,請隨意修改您下載的文件。接下來,將這些文件添加到GitHub存儲庫中,啟用githubpages,并完成項目。

創建示例GitHub存儲庫,并使用以下GitHub命令簽出、提交和推送代碼:

設置githubpages頁面。在新的GitHub存儲庫中,單擊“設置”:

如何使用docsify和GitHub頁面創建文檔網站?

(圖1)

設置鏈接到Sub

向下滾動直到看到githubpages:

GithubPages設置

“查找”部分:

GithubPages設置

單擊“源”下的下拉菜單。通常,您會將其設置為“主分支”,但如果您愿意,也可以使用其他分支:

設置SourceToMasterBranch

就這樣!現在應該有一個鏈接到githubpages的頁面。單擊此鏈接將帶您到那里,然后使用docsify呈現它:

鏈接到SubpagesDocssite

應該是這樣的:

示例Docsifysiteongitubpage

如何自己創建網站?通過編輯HTML文件和一些降價文本,您可以使用docsify創建一個外觀漂亮的文檔網站。你覺得怎么樣?請留言并分享其他可以與githubpages一起使用的開源工具。

未經允許不得轉載:啟新網站SEO優化 » 如何使用docsify和GitHub頁面創建文檔網站?
分享到: 更多 (0)
加載中~
主站蜘蛛池模板: 江苏远邦专注皮带秤,高精度皮带秤,电子皮带秤研发生产 | 上海平衡机-单面卧式动平衡机-万向节动平衡机-圈带动平衡机厂家-上海申岢动平衡机制造有限公司 | 光照全温振荡器(智能型)-恒隆仪器 | 折弯机-刨槽机-数控折弯机-数控刨槽机-数控折弯机厂家-深圳豐科机械有限公司 | 【ph计】|在线ph计|工业ph计|ph计厂家|ph计价格|酸度计生产厂家_武汉吉尔德科技有限公司 | 郑州爱婴幼师学校_专业幼师培训_托育师培训_幼儿教育培训学校 | 翅片管散热器价格_钢制暖气片报价_钢制板式散热器厂家「河北冀春暖气片有限公司」 | 水稻烘干机,小麦烘干机,大豆烘干机,玉米烘干机,粮食烘干机_巩义市锦华粮食烘干机械制造有限公司 水环真空泵厂家,2bv真空泵,2be真空泵-淄博真空设备厂 | RFID电子标签厂家-上海尼太普电子有限公司 | 座椅式升降机_无障碍升降平台_残疾人升降平台-南京明顺机械设备有限公司 | 上海宿田自动化设备有限公司-双面/平面/单面贴标机 | 上海皓越真空设备有限公司官网-真空炉-真空热压烧结炉-sps放电等离子烧结炉 | 手机存放柜,超市储物柜,电子储物柜,自动寄存柜,行李寄存柜,自动存包柜,条码存包柜-上海天琪实业有限公司 | 平面钻,法兰钻,三维钻-山东兴田阳光智能装备股份有限公司 | 手术室净化装修-手术室净化工程公司-华锐手术室净化厂家 | 工业插头-工业插头插座【厂家】-温州罗曼电气 | 衢州装饰公司|装潢公司|办公楼装修|排屋装修|别墅装修-衢州佳盛装饰 | 打包箱房_集成房屋-山东佳一集成房屋有限公司 | 环讯传媒,永康网络公司,永康网站建设,永康小程序开发制作,永康网站制作,武义网页设计,金华地区网站SEO优化推广 - 永康市环讯电子商务有限公司 | 金属波纹补偿器厂家_不锈钢膨胀节价格_非金属伸缩节定制-庆达补偿器 | ETFE膜结构_PTFE膜结构_空间钢结构_膜结构_张拉膜_浙江萬豪空间结构集团有限公司 | 成都软件开发_OA|ERP|CRM|管理系统定制开发_成都码邻蜀科技 | 石油/泥浆/不锈钢防腐/砂泵/抽砂泵/砂砾泵/吸砂泵/压滤机泵 - 专业石油环保专用泵厂家 | 丁基胶边来料加工,医用活塞边角料加工,异戊二烯橡胶边来料加工-河北盛唐橡胶制品有限公司 | 【中联邦】增稠剂_增稠粉_水性增稠剂_涂料增稠剂_工业增稠剂生产厂家 | 河北凯普威医疗器材有限公司,高档轮椅系列,推车系列,座厕椅系列,协步椅系列,拐扙系列,卫浴系列 | 实验室隔膜泵-无油防腐蚀隔膜泵-耐腐蚀隔膜真空泵-杭州景程仪器 电杆荷载挠度测试仪-电杆荷载位移-管桩测试仪-北京绿野创能机电设备有限公司 | 膜结构_ETFE膜结构_膜结构厂家_膜结构设计-深圳市烨兴智能空间技术有限公司 | CCE素质教育博览会 | CCE素博会 | 教育展 | 美育展 | 科教展 | 素质教育展 | 开云(中国)Kaiyun·官方网站 - 登录入口 | MOOG伺服阀维修,ATOS比例流量阀维修,伺服阀维修-上海纽顿液压设备有限公司 | 防爆大气采样器-防爆粉尘采样器-金属粉尘及其化合物采样器-首页|盐城银河科技有限公司 | 软文推广发布平台_新闻稿件自助发布_媒体邀约-澜媒宝 | 捆扎机_气动捆扎机_钢带捆扎机-沈阳海鹞气动钢带捆扎机公司 | 模切之家-专注服务模切行业的B2B平台!| led太阳能路灯厂家价格_风光互补庭院灯_农村市政工程路灯-中山华可路灯品牌 | 寮步纸箱厂_东莞纸箱厂 _东莞纸箱加工厂-东莞市寮步恒辉纸制品厂 | RO反渗透设备_厂家_价格_河南郑州江宇环保科技有限公司 | 背压阀|减压器|不锈钢减压器|减压阀|卫生级背压阀|单向阀|背压阀厂家-上海沃原自控阀门有限公司 本安接线盒-本安电路用接线盒-本安分线盒-矿用电话接线盒-JHH生产厂家-宁波龙亿电子科技有限公司 | Boden齿轮油泵-ketai齿轮泵-yuken油研-无锡新立液压有限公司 | 四川实木门_成都实木门 - 蓬溪聚成门业有限公司 |