Milou 是一個靜態網站產生器,可協助您建立美觀且資訊豐富的新聞資料袋,以向媒體展示您的公司和產品。它可以讓您以結構化且引人入勝的方式展示您的品牌故事、新聞稿、媒體資產和關鍵團隊成員。
您將需要一個終端機和 Node.js。
使用 npm 安裝 Milou:
npm install -g milou
建立一個包含您公司資料的新目錄:
mkdir mypresskit
cd mypresskit
milou new
您的專案的根目錄包含您的公司資料。您應該透過填寫此目錄中產生的data.yml
檔案來展示您的公司。您可以使用此完整公司data.yml
檔案範例作為參考。
您應該將您公司的圖像放在images
資料夾中。名為header.*
的圖片(例如header.png
或header.jpg
)將在頁首中使用。以logo
為前綴的檔案(例如logo01.png
或logo.jpg
)將放置在頁面的標誌部分。此資料夾中的任何其他圖像都將作為圖像包含在生成的新聞資料中。
若要包含自訂 CSS 文件,請在公司資料夾中建立一個名為style.css
的文件。它將自動包含在每個頁面中。
建立一個包含產品的新子目錄:
mkdir myproduct
cd mypresskit
milou new -t product
產品資料夾將包含您的軟體、遊戲或任何其他類型產品的資料。與公司一樣,將您的內容寫入此目錄中產生的data.yml
檔案中。您可以將此範例文件作為參考。
圖像也應包含在新images
資料夾中。
您的項目現在應該如下所示:
? data.yml
images/
? header.png
? logo.png
myproduct/
? data.yml
images/
? header.png
? logo.png
? screenshot1.png
? screenshot2.png
現在,您可以從專案的根目錄建立靜態網站:
milou build .
這將在build
資料夾中輸出靜態 HTML、CSS 和映像。現在您可以啟動 Web 伺服器來提供您的內容:
cd build
npx serve
將此資料夾上傳到任何靜態網站主機(GitHub 頁面、Netlify、CloudFlare 頁面等),以使全世界都可以存取您的新聞資料包。
milou new [options] <destination>
Create an empty `data.yml` file and its `images/` folder in the <destination> folder (current working directory by default).
There are two template types available: company (default) or product.
Options:
-V, --version output the version number
-t, --type [company] set the type of the new `data.yml` file (default: "company")
-h, --help display help for command
milou build [options] <entry point>
Generate a press kit based on information found in `data.yml` files.
Options:
-V, --version output the version number
-o, --output [destination] output the build folder to the [destination] (defaults to ./build) (default: "/Users/alicegg/Code/mypresskit/myproduct/build")
-w, --watch watch project for changes and re-generate if needed
-p, --port [8080] set the server port to [8080] (default: 8080)
-D, --clean-build-folder delete the build folder beforehand
-T, --ignore-thumbnails use original images in galleries instead of thumbnails (will increase pages size)
-h, --help display help for command
Milou 是從 presskit.html 分叉出來的,由 Pixelnest Studio 製作。
Presskit.html 的靈感來自 Rami Ismail 製作的 presskit()。