开源项目 `makesite`: 快速搭建静态网站指南

最新推荐文章于 2024-09-10 23:28:43 发布

裘晴惠Vivianne

最新推荐文章于 2024-09-10 23:28:43 发布

阅读量839

点赞数 17

本文链接：https://blog.csdn.net/gitblog_00234/article/details/141481742

版权

开源项目 `makesite`: 快速搭建静态网站指南

makesiteSimple, lightweight, and magic-free static site/blog generator for Python coders项目地址:https://gitcode.com/gh_mirrors/ma/makesite

项目简介

makesite 是一个简洁高效的静态网站生成器，由 sunainapai 开发维护。本教程将引导您了解其核心结构、启动机制以及配置方式，以便快速上手并自定义您的静态网站。

1. 项目目录结构及介绍

项目克隆下来后的基本目录结构如下：

makesite/
│
├── config.toml       # 配置文件，用于定制站点设置
├── content/          # 内容存放目录，Markdown 或 HTML 文件存放于此，用于生成网页内容
├── templates/        # 模板文件夹，包含HTML模板，定义页面布局和样式
├── static/           # 静态资源目录，如CSS、JavaScript、图片等不会被处理的文件
├── makesite.go       # 主程序入口，启动项目的关键文件
└── README.md         # 项目说明文件

config.toml : 包含了站点的基本信息、元数据设定、路径配置等。
content/ : 直接影响最终生成网站的内容部分。
templates/ : 网站的外观设计相关，通过这些模板文件编排HTML结构。
static/ : 存放网站所需的各类静态文件，不会经过编译直接复制到最终站点中。
makesite.go : 应用的主程序，运行此文件即可启动静态网站构建过程。

2. 项目的启动文件介绍

启动文件： makesite.go

该文件是整个项目的驱动中心，它包含了初始化应用程序、读取配置、处理内容文件、应用模板以及生成静态网页的主要逻辑。执行这个Go程序时，它会依据config.toml中的指令，从content/目录下读取Markdown或HTML文件，结合templates/下的模板，生成对应的静态HTML网页，并输出到指定的目录或默认站点目录。

要启动项目，您通常需要先确保具备Go语言环境，然后在项目根目录下执行以下命令：

go run makesite.go

这将会根据配置文件和内容文件构建您的静态网站。

3. 项目的配置文件介绍

配置文件： config.toml

config.toml 是一个键值对形式的配置文件，允许开发者或用户定义站点的基本属性和行为。下面是一些关键配置项的例子：

[site]
title = "我的个人站点"    # 网站标题
author = "您的名字"      # 作者名
baseurl = "http://example.com/"   # 网站基础URL

[output]
path = "./public"    # 输出静态文件的目录

[languages]
defaultContentLanguage = "zh" # 默认内容语言

[menu]
  [[menu.main]]
    name = "首页"
    identifier = "home"
    url = "/"
    weight = 1