地址
官網: https://www.showdoc.com.cn
開源地址: https://github.com/star7th/showdoc
更新了什麼
ShowDoc是一個非常適合IT團隊的線上API檔案、技術檔案工具,既有免費開源版,也有開箱可用的線上官網版。
本次版本v3.1.0主要新增了AI助手功能,整合了chatGPT的能力來輔助使用者生成檔案內容。
如何使用AI助手
在showdoc的新建/編輯頁面,可以使用AI助手來自動補全生成一些檔案內容。你可以輸入一些關鍵字,或者幾句話,然後讓AI來幫你寫完整。
比如,你可以在輸入框輸入:
請分別用 C, C++ , java ,php ,go , js 生成氣泡排序程式碼,以markdown格式輸出。
那麼它就會輸出幾個程式碼塊,每個程式碼塊對應著一種語言實現的氣泡排序。
你也可以輸入:
請根據以下關鍵字,生成一篇連貫的微小說,一百字左右:
地球,星空,流星,山巒,湖泊,森林
這樣AI就會生成一段文字,且字數按照你的要求來生成。比如以上的關鍵詞會生成下面的結果
蘇輕望著星空,看到流星劃過夜空,他心中充滿了期待與驚喜。
此時此刻,他只想要繼續沉醉在大自然的寧靜當中,享受這片完美的天地。
他慢慢地朝前走去,穿越山巒,來到一個綠意盎然的湖泊邊,森林四周,
一片幽靜。蘇輕心沾湖靜,感受著這片神奇的地球,他向它敬禮,以此來表達對它的尊重。
你甚至可以利用AI來做語言轉換,比如:
請把以下程式碼,改用js來實現,以markdown程式碼塊輸出
function send_post($url, $post_data) {
$postdata = http_build_query($post_data);
$options = array(
'http' => array(
'method' => 'POST',
'header' => 'Content-type:application/x-www-form-urlencoded',
'content' => $postdata,
'timeout' => 15 * 60 // 超時時間(單位:s)
)
);
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
return $result;
};
得到結果(當然,太深入的程式碼,它生成的不會完全正確,但是在此基礎上手工改正,總比從頭開始寫要輕鬆)
// 使用JS實現以上功能
function send_post(url, post_data) {
const postdata = new URLSearchParams(post_data).toString();
const options = {
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded'
},
body: postdata,
timeout: 15 * 60 // 超時時間(單位:s)
};
return fetch(url, options)
.then(response => response.text());
}
其他說明
如果你是使用官網線上服務,https://www.showdoc.com.cn/ ,則預設啟動AI助手功能。
如果你是部署私有版showdoc,你則需要有chatGPT賬號,然後登入其官網 ,開啟 https://platform.openai.com/account/api-keys 來獲取API KEY。
進入showdoc管理後臺設定好API KEY後 ,你可能還需要解決伺服器的網路問題,確保伺服器正確聯通 https://api.openai.com 這個地址。如果你無法解決讓伺服器“科學上網”的問題,可能無法使用AI 。