靜態(tài)站點(diǎn)生成器是功能強(qiáng)大的工具，可以簡(jiǎn)化輕量級(jí)、快速且可擴(kuò)展的網(wǎng)站的創(chuàng)建。無(wú)論您是構(gòu)建博客、文檔還是小型企業(yè)網(wǎng)站，它們都會(huì)將用 Markdown 編寫(xiě)的內(nèi)容轉(zhuǎn)換為高效的靜態(tài) HTML 文件。

在本指南中，我們將使用 Go 創(chuàng)建一個(gè) 靜態(tài)站點(diǎn)生成器 (SSG)，Go 是一種以其性能、簡(jiǎn)單性和并發(fā)性而聞名的編程語(yǔ)言。我們將構(gòu)建一個(gè) CLI 工具，它將 Markdown 文件作為輸入，使用預(yù)定義的 HTML 模板對(duì)其進(jìn)行處理，并輸出漂亮的靜態(tài) HTML 頁(yè)面。

---

為什么要構(gòu)建這個(gè)？

靜態(tài)站點(diǎn)生成器可以滿(mǎn)足多種實(shí)際用途：

• 文檔站點(diǎn)：生成技術(shù)文檔的快速加載站點(diǎn)。
• 博客：用 Markdown 編寫(xiě)內(nèi)容并輕松部署。
• 原型制作：快速啟動(dòng)小型項(xiàng)目或展示的靜態(tài)網(wǎng)站。

為什么在這個(gè)項(xiàng)目中使用 Go？

• 速度：Go 編譯為本機(jī)機(jī)器代碼，使得此類(lèi)工具速度極快。
• 并發(fā)：Go 可以輕松同時(shí)處理多個(gè)文件。
• 簡(jiǎn)單：Go 的語(yǔ)法非常簡(jiǎn)單，構(gòu)建 CLI 工具也很簡(jiǎn)單。

---

構(gòu)建這個(gè)項(xiàng)目我玩得很開(kāi)心:)

項(xiàng)目設(shè)置

在深入代碼之前，我們先概述一下項(xiàng)目的結(jié)構(gòu)：

static-site-generator/
├── cmd/
│   └── ssg/
│       └── main.go           # Entry point
├── internal/
│   ├── generator/
│   │   └── html.go          # HTML generation logic
│   ├── parser/
│   │   ├── frontmatter.go   # YAML frontmatter parsing
│   │   └── markdown.go      # Markdown processing
│   └── watcher/
│       └── watcher.go       # File change detection
├── templates/
│   └── default.html         # HTML template
├── content/                 # Markdown files
└── output/

如果您想從頭開(kāi)始構(gòu)建，請(qǐng)運(yùn)行此命令來(lái)初始化項(xiàng)目的 Go 模塊

go mod init

---

主要特點(diǎn)：

• 將 Markdown 轉(zhuǎn)換為 HTML ？

• 用于元數(shù)據(jù)解析的 YAML frontmatter

• 用于可自定義輸出的 HTML 模板

• 使用觀(guān)察者實(shí)時(shí)文件更改檢測(cè)？

建設(shè)項(xiàng)目

1. 克隆存儲(chǔ)庫(kù)

開(kāi)始之前，將存儲(chǔ)庫(kù)克隆到本地計(jì)算機(jī)：

git clone https://github.com/Tabintel/static-site-generator.git
cd static-site-generator

這將為您提供構(gòu)建和運(yùn)行 SSG 所需的所有入門(mén)文件和項(xiàng)目結(jié)構(gòu)。

---

2.Markdown解析器

Markdown 解析器處理將 .md 文件轉(zhuǎn)換為 HTML 內(nèi)容。它還支持自動(dòng)標(biāo)題 ID 等擴(kuò)展功能。

內(nèi)部/解析器/markdown.go

static-site-generator/
├── cmd/
│   └── ssg/
│       └── main.go           # Entry point
├── internal/
│   ├── generator/
│   │   └── html.go          # HTML generation logic
│   ├── parser/
│   │   ├── frontmatter.go   # YAML frontmatter parsing
│   │   └── markdown.go      # Markdown processing
│   └── watcher/
│       └── watcher.go       # File change detection
├── templates/
│   └── default.html         # HTML template
├── content/                 # Markdown files
└── output/

?將 Markdown 內(nèi)容轉(zhuǎn)換為 HTML 格式，并提供擴(kuò)展功能支持。

---

3. Frontmatter 解析器

frontmatter 解析器從 Markdown 文件中提取標(biāo)題、日期、標(biāo)簽和描述等元數(shù)據(jù)。

內(nèi)部/解析器/frontmatter.go

go mod init

？提取并返回元數(shù)據(jù)以及 Markdown 文件的內(nèi)容。

---

4. HTML 生成器

HTML 生成器使用 Go 的 html/template 包基于模板創(chuàng)建靜態(tài) HTML 頁(yè)面。

內(nèi)部/generator/html.go

git clone https://github.com/Tabintel/static-site-generator.git
cd static-site-generator

？從模板和解析的 Markdown 內(nèi)容生成 HTML 文件。

---

5. 文件觀(guān)察器

我們的觀(guān)察者監(jiān)視內(nèi)容/目錄的更改并自動(dòng)觸發(fā)重建。

這是使用 https://github.com/fsnotify/fsnotify

構(gòu)建的

內(nèi)部/watcher/watcher.go

package parser

import (
    "github.com/gomarkdown/markdown"
    "github.com/gomarkdown/markdown/parser"
)

type MarkdownContent struct {
    Content    string
    Title      string
    Date       string
    Tags       []string
    HTMLOutput string
}

func ParseMarkdown(content []byte) *MarkdownContent {
    extensions := parser.CommonExtensions | parser.AutoHeadingIDs
    parser := parser.NewWithExtensions(extensions)
    html := markdown.ToHTML(content, parser, nil)

    return &MarkdownContent{
        Content:    string(content),
        HTMLOutput: string(html),
    }
}

？檢測(cè)文件更改并自動(dòng)重新生成靜態(tài)文件。

---

六、主要用途

入口點(diǎn)將所有組件聯(lián)系在一起，并提供用于自定義的 CLI 選項(xiàng)。

cmd/ssg/main.go

package parser

import (
    "bytes"
    "gopkg.in/yaml.v2"
)

type Frontmatter struct {
    Title       string   `yaml:"title"`
    Date        string   `yaml:"date"`
    Tags        []string `yaml:"tags"`
    Description string   `yaml:"description"`
}

func ParseFrontmatter(content []byte) (*Frontmatter, []byte, error) {
    parts := bytes.Split(content, []byte("---"))
    if len(parts) < 3 {
        return nil, content, nil
    }

    var meta Frontmatter
    err := yaml.Unmarshal(parts[1], &meta)
    if err != nil {
        return nil, content, err
    }

    return &meta, bytes.Join(parts[2:], []byte("---")), nil
}

---

用法

在運(yùn)行應(yīng)用程序之前，使用 .md 創(chuàng)建一個(gè) markdown 文件并將其保存在內(nèi)容目錄中

然后運(yùn)行生成器：

package generator

import (
    "html/template"
    "os"
    "path/filepath"
)

type Generator struct {
    TemplateDir string
    OutputDir   string
}

func NewGenerator(templateDir, outputDir string) *Generator {
    return &Generator{
        TemplateDir: templateDir,
        OutputDir:   outputDir,
    }
}

func (g *Generator) Generate(data interface{}, outputFile string) error {
    if err := os.MkdirAll(g.OutputDir, 0755); err != nil {
        return err
    }

    tmpl, err := template.ParseFiles(filepath.Join(g.TemplateDir, "default.html"))
    if err != nil {
        return err
    }

    out, err := os.Create(filepath.Join(g.OutputDir, outputFile))
    if err != nil {
        return err
    }
    defer out.Close()

    return tmpl.Execute(out, data)
}

它將 markdown 文件轉(zhuǎn)換為 HTML 文件并將其保存在輸出目錄中

如您所見(jiàn)，它添加了格式以使其具有視覺(jué)吸引力:)

留意變化

啟用觀(guān)察者：

package watcher

import (
    "fmt"
    "github.com/fsnotify/fsnotify"
    "log"
    "os"
    "path/filepath"
)

type ProcessFn func() error

func Watch(dir string, process ProcessFn) error {
    watcher, err := fsnotify.NewWatcher()
    if err != nil {
        return err
    }
    defer watcher.Close()

    done := make(chan bool)
    go func() {
        for {
            select {
            case event, ok := <-watcher.Events:
                if !ok {
                    return
                }
                if event.Op&fsnotify.Write == fsnotify.Write {
                    fmt.Printf("Modified file: %s\n", event.Name)
                    if err := process(); err != nil {
                        log.Printf("Error processing: %v\n", err)
                    }
                }
            case err, ok := <-watcher.Errors:
                if !ok {
                    return
                }
                log.Printf("Error: %v\n", err)
            }
        }
    }()

    err = filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
        if err != nil {
            return err
        }
        if info.IsDir() {
            return watcher.Add(path)
        }
        return nil
    })
    if err != nil {
        return err
    }

    <-done
    return nil
}

---

就是這樣！

此 SSG 將 markdown 轉(zhuǎn)換為干凈的 HTML，監(jiān)視更改并保持您的內(nèi)容井井有條。如果您用它構(gòu)建了一些東西，請(qǐng)發(fā)表評(píng)論 - 我很想看看您創(chuàng)建的內(nèi)容！

覺(jué)得這有幫助嗎？你可以請(qǐng)我喝杯咖啡來(lái)支持更多Go教程！ ?

編碼愉快！ ？

以上是如何使用 Go 創(chuàng)建靜態(tài)站點(diǎn)生成器的詳細(xì)內(nèi)容。更多信息請(qǐng)關(guān)注PHP中文網(wǎng)其他相關(guān)文章！