Infection Monkey 貢獻文件

目錄結構

按重要性順序：

內容

最重要的目錄是 /content：這是包含內容文件的目錄。

靜態的

在此目錄中，您應該放置圖像，css文件，js文件以及站點應提供的其他靜態內容。要訪問頁面中的靜態內容，請使用類似于以下內容的內容：

![AWS instance ID](../../images/setup/aws/aws-instance-id.png "AWS instance ID")

配置

此文件夾控制有關網站生成的許多參數。

主題

我們正在使用的主題。這是一個子模塊（需要運行它git submodule update）。

布局和原型

該目錄包括自定義 HTML部分，自定義簡碼，以及內容模板。最好不要在這里與現有的東西混淆太多，而要添加新的東西。

公共資源

這些是的構建輸出，hugo永遠不應commit-ed到git。

如何貢獻

要求

你必須 安裝 hugo，這是一款好用的Markdown編輯器（vscode并且vim是不錯的選擇）和git。

添加和編輯內容

新增頁面

跑 hugo new folder/page.md。（可選）添加--kind chapter如果這是新的章節頁面。例如，hugo new usage/getting-started.md 創建了“入門”頁面。

編輯現有頁面

編輯markdown 文件。如果要添加圖像，請將其添加到static/images 文件夾，并按名稱引用它們。

建立內容

在本地提供文檔

跑 hugo server -D。該服務器將在本地可用http://localhost:1313/。您可以更改內容/主題，站點將自動刷新以反映您的更改。

構建要部署的內容

運行 hugo --environment staging 要么 hugo --environment production。這將在public目錄。該目錄應該被忽略git- 確保您不要錯誤地添加和提交它！

故障排除

Error: Unable to locate config file or config directory. Perhaps you need to create a new site.

您的工作目錄是什么？它應該是monkey/docs。

failed to extract shortcode: template for shortcode "children" not found 或主題似乎不正確？

你運行 git submodule update了嗎？

缺少CSS

• 確保您訪問的是正確的URL。
• 檢查 config.toml 文件。