Docsify使用指南,使用Typora+Docsify打造最強、最輕量級的個人&團隊文檔,及免費和開源且低成本文檔工具

来源:https://www.cnblogs.com/YushinFukuhara/archive/2022/08/26/16627478.html
-Advertisement-
Play Games

隨著學習知識的積累,我們需要掌握的知識越來越多,這是就有一個問題出現了,如何把我們學習到的知識整理起來,讓我們更方便的去管理和閱讀,同事還想把我們所學習到的知識分析個小伙伴。這是我們就需要一個很方便的味文檔管理工具了,在這裡就給大家介紹一個款線上免費開源的文檔管工具【Docsify-Plus文檔工具 ...


隨著學習知識的積累,我們需要掌握的知識越來越多,這是就有一個問題出現了,如何把我們學習到的知識整理起來,讓我們更方便的去管理和閱讀,同事還想把我們所學習到的知識分析個小伙伴。這是我們就需要一個很方便的味文檔管理工具了,在這裡就給大家介紹一個款線上免費開源的文檔管工具【Docsify-Plus文檔工具】。

Docsify-Plus文檔工具】是本人搭建的一款開箱即用的文檔工具,只需下載源碼 直接運行即可,無需編寫代碼,只需修改少量配置就可以搭建起自己的文檔工具,配合【Gitee Pages】實現了低成本工具。

Docsify-Plus文檔工具 是基於Docsify.js 配置的一套開源框架,實現了直接使用 Markdown標記語言發佈文檔。無需對Markdown文檔進行任何的修改,直接在項目中創建.md的Markdown文檔編輯,直接發佈Markdown,發佈完後直接訪問項目即可。

 

 

 

 

docsify 可以快速幫你生成文檔網站。不同於 GitBook、Hexo 的地方是它不會生成靜態的 .html 文件,所有轉換工作都是在運行時。如果你想要開始使用它,只需要創建一個 index.html 就可以開始編寫文檔並直接部署。

 

 

 

Docsify-Plus部署

Docsify-Plus文檔更適合做幫助文檔和筆記工具,還支持多種部署方式,

Docsify-Plus表情

Docsify-Plus文檔預設配置有一百多個表情,豐富你的文檔記錄

 

 

 

Docsify-Plus開發教程

Docsify-Plus開發需要使用到node 開發環境,和docsify-cli依賴包

 

安裝node環境

安裝docsify-cli之前,我們需要安裝npm包管理器,而安裝了node.js就會自動安裝npm

 

安裝node

官網下載安裝程式,雙擊下載的exe安裝,下一步下一步直到完成。

官網地址:https://nodejs.org/en/

 

驗證安裝

輸入node -v,npm -v輸出版本就是安裝成功了

#驗證node
node -v

#驗證npm
npm -v

安裝docsify-cli工具

推薦全局安裝 docsify-cli 工具,可以方便地創建及在本地預覽生成的文檔。

#用npm安裝全局工具
npm i docsify-cli -g

 

下載Docsify-Plus項目

Gitee地址:
https://gitee.com/librarycodes/docsify-plus

GitHub地址:
https://github.com/shiming-git/docsify-plus

運行Docsify-Plus項目

預設運行埠為 3000 docs為Docsify-Plus的預設目錄,此目錄可自行更改,可改為更目錄

#進入項目
cd
docsify serve docs
#啟動項目
docsify serve docs

指定埠運行

-p 80 指定運行埠 為 80

docsify serve -p 80 docs

本地預覽

游覽器打開輸入訪問地址,http://{你的ID地址}:{你指定的埠}

http://localhost:3000

 

Docsify-Plus開發

目錄介紹

docsify-plus                    #項目
|__ docs                        #文檔目錄     可選
   |__ contents                 #文檔文件夾     可選
      |__ development.md        #快速開始       頁面文件
      |__ guide.md              #指南           頁面文件
   |__ zh-en                    #不同語言目錄   可選
      |__ _coverpage.md         #當前語言封面
      |__ _navbar.md            #當前語言導航頁面
      |__ _sidebar.md           #當前語言菜單頁面
      |__ README.md             #當前語言首頁面
   |__ 404.md                   #錯誤頁面 可選
   |__ _coverpage.md            #預設語言封面 可選
   |__ _navbar.md               #預設語言導航 可選
   |__ _sidebar.md              #預設語言菜單 可選
   |__ index.html               #程式入口 必選 可配置
   |__ README.md                #預設語言首頁 可選
|__ .nojekyll                   #git配置
|__ LICENSE                     #git配置
|__ README.md                   #git說明頁面

菜單列表路徑

你可以簡單地在你的 docsify 目錄中創建更多的 markdown 文件,你可以在菜單_sidebar.md添加目錄,系統菜單是以 相對路徑 訪問頁面

將你自定義的菜單文件添加到菜單列表中 就可以預覽文件內容了,項目 目錄不是固定的開發者可根據自己的需要去修改文件路徑,最終要將文件相對路徑添加到菜單列表即可。

* [介紹](README.md)
* [快速開始](contents/development)
* [指南](contents/guide)

 

從側邊欄選擇設置頁面標題

頁面的title標簽是從選定的側邊欄項目名稱生成的。為了更好的顯示,您可以通過在文件名後指定一個字元串來自定義標題。

* [指南](contents/guide "文檔指南")

 

Docsify-Plus部署到gitee

windows安裝git,管理頁面

window上主要是日常博客的編寫,然後用git來管理,上傳到gitee後,可以配置生成GiteePages。具體的git操作和配置可以參考git詳解文章,這裡創建了一個gitee倉庫,專門用來做個人網站。下麵紅框框出來的是docsify生成的幾個配置文件。

 

Gitee配置Gitee Pages

第一次配置需要實名認證,上傳身份證正反面,手持身份證照片。

部署選擇你要部署的分支,部署的目錄就是docsify對應倉庫中的目錄,我這邊是整個倉庫作為docsify目錄,建議強制使用https勾選,然後就可以啟動。

 

 

 

頁面效果請參考

生成的giteePages地址是https://bluecusliyou.gitee.io/techlearn

 

頁面修改更新

如果頁面內容有修改更新到倉庫了,可以點擊更新個人頁面

 

 

 

 

 好東西話不多說直接上源碼。

Docsify-Plus演示:https://gitee.com/librarycodes/docsify-plus

Gitee源碼地址:https://gitee.com/librarycodes/docsify-plus

GitHub源碼地址:https://gitee.com/librarycodes/docsify-plus

Docsify官網:https://docsify.js.org/#/

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 本文介紹 Kubernetes 支持資料庫等有狀態應用的常見解決方案:StatefulSet。 在構建機器學習向量管理層時,我們面臨的一個重要問題:如何持久化數據以避免數據丟失? 在閱讀了許多資料庫企業發佈的博客後,我們認為 StatefulSet[1] 是實現這個目標的可行方法。 我們研究了不同的 ...
  • 1. 主從原理 1.1 主從介紹 所謂 mysql 主從就是建立兩個完全一樣的資料庫,其中一個為主要使用的資料庫,另一個為次要的資料庫,一般在企業中,存放比較重要的數據的資料庫伺服器需要配置主從,這樣可以防止因資料庫伺服器宕機導致數據丟失,還能保證業務量太多、數據太多和訪問人數太多時服務的質量(服務 ...
  • HMS Core Discovery第17期直播《音隨我動,秒變音色造型師》,已於8月25日圓滿結束,本期直播我們邀請了HMS Core音頻編輯服務的產品經理、技術專家以及創新娛樂類應用“唱鴨”的創始人做客直播間,分享影音娛樂行業發展的洞見及音頻技術新玩法。一起來回顧本期精彩內容吧! 【精彩回顧】 ...
  • 分析服務 ◆ 留存分析支持¬將流失用戶存為受眾,開發者通過對流失人群的分層以及多維分析,在制定相關用戶召回策略時將更有針對性; ◆ 原“受眾分析”更名為“人群洞察”,下設“用戶分群”和“用戶畫像”模塊。通過用戶分群可實現不同維度的受眾細分,通過用戶畫像則可以進一步分析對應細分群組的人群畫像與屬性等特 ...
  • 本文是深入淺出 ahooks 源碼系列文章的第十三篇,該系列已整理成文檔-地址。覺得還不錯,給個 star 支持一下哈,Thanks。 本篇文章探討一下 ahooks 對 DOM 類 Hooks 使用規範,以及源碼中是如何去做處理的。 DOM 類 Hooks 使用規範 這一章節,大部分參考官方文檔的 ...
  • jQuery(write less do more) jQuary是一個輕量級的、相容多瀏覽器的JavaScript庫 jQuery使用戶能夠更方便地處理HTML Document、Events、實現動畫效果、方便地進行Ajax交互,能夠極大地簡化JavaScript編程。它的宗旨就是:“Write ...
  • js獲取值操作 1.獲取用戶數據標簽內部的數據 >HTML代碼 <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Title</title> </head> <body> <input type="text" ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 本文說明 本文主要簡單介紹了,在Vue3.x項目中如何簡單的使用Three.js,導入PCD三維模型文件。 模型顯示 項目實現 第一步 首先創建一個vue3.x,的項目,然後需要先有一個 .pcd三維模型文件,如果有的話,將三維點雲文件放 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...