docsifyの基本機能紹介

作者：contr4l_

一つの魔法のドキュメントウェブサイトジェネレータ。

Docsify の紹介については、docsifyをご覧ください。ここでは繰り返しませんが、このツールは整理されたドキュメントをウェブサイトに組織し、外部に提供するためのものです。

docsify のインストール#

Node.js のインストール#

公式のダウンロードリンクはNode.jsで、通常はLTSバージョンのダウンロードをお勧めします。

インストールプロセス中に、環境変数に node/npm を追加するかどうかのオプションがある場合は、チェックを入れてください。 Add xxx to environment PATH

インストール結果を確認するには：Win+Rを押してpowershellを入力し、Windows PowerShellを開き、npm -vを入力します。出力結果は次のようになります。

PS C:\Users\ctrl> npm -v
9.5.0
# ユーザーのNode.jsのバージョンによって、数字は異なる場合があります

docsify のインストール#

docsify は実際には npm で管理されているフレームワークですので、docsify をインストールするには npm を使用する必要があります。

npm i docsify-cli -g
# PS C:\Users\ctrl> npm i docsify-cli -g
# added 204 packages in 33s
# 16 packages are looking for funding
#   run `npm fund` for details

# Linuxシステムの場合は、sudo npm i docsify -gを使用してください

docsify のパスをシステムの環境変数に追加した後、設定ウィンドウをすべて確認して閉じてください。

ここで環境変数のパスは、自分のシステムの docsify.ps1 の場所に基づいて決定する必要があります。それぞれ異なります

管理者権限で powershell を開き、set-ExecutionPolicy RemoteSignedを入力してカスタムスクリプトの実行権限を追加します。


# PS C:\WINDOWS\system32> set-ExecutionPolicy RemoteSigned
# 执行策略更改
# 执行策略可帮助你防止执行不信任的脚本。更改执行策略可能会产生安全风险，如 https:/go.microsoft.com/fwlink/?LinkID=135170
# 中的 about_Execution_Policies 帮助主题所述。是否要更改执行策略?
# [Y] 是(Y)  [A] 全是(A)  [N] 否(N)  [L] 全否(L)  [S] 暂停(S)  [?] 帮助 (默认值为“N”): 

# **Aを入力してEnter**

docsifyを実行して結果をテストします。

PS C:\WINDOWS\system32> docsify
Usage: docsify <init|serve> <path>

Commands:
  docsify init [path]      Creates new docs                         [aliases: i]
  docsify serve [path]     Run local server to preview site.        [aliases: s]
  docsify start <path>     Server for SSR
  docsify generate <path>  Docsify's generators                     [aliases: g]

Global Options
  --help, -h     Show help                                             [boolean]
  --version, -v  Show version number                                   [boolean]

docsify を使用してウェブページを生成する#

# gh-pagesブランチに切り替える
PS C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki> git checkout gh-pages
Switched to a new branch 'gh-pages'
branch 'gh-pages' set up to track 'origin/gh-pages'.

# docsifyでウェブページを生成する
PS C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki> docsify serve ./

Serving C:\Users\ctrl\Desktop\TornCity\TornCity-CnWiki now.
Listening at http://localhost:3000

# 最後にブラウザでhttp://localhost:3000にアクセスして結果を確認します