用Publish创建博客（三）——插件开发

try Myblog().publish(withTheme: .foundation)

try Myblog().publish(using: [    .addMarkdownFiles(), //导入Content目录下的markdown文件，并解析添加到PublishingContent中    .copyResources(), //将Resource内容添加到Output中    .generateHTML(withTheme:.foundation ), //指定模板    .generateRSSFeed(including: [.posts]), //生成RSS    .generateSiteMap() //生成Site Map])

//当前的Section设置enum SectionID: String, WebsiteSectionID {        // Add the sections that you want your website to contain here:        case posts //rawValue 将影响该Section对应的Content的目录名。当前的目录为posts        case about //如果改成 case abot = "关于" 则目录名为“关于”，所以通常会采用下方更改title的方法 }//创建Stepextension PublishingStep where Site == Myblog {    static func addDefaultSectionTitles() -> Self {      //name为step名称，在执行该Step时在控制台显示        .step(named: "Default section titles") { context in //PublishingContent实例            context.mutateAllSections { section in //使用内置的修改方法                switch section.id {                case .posts:                    section.title = "文章"  //修改后的title，将显示在上方的Nav中                case .about:                    section.title = "关于"                 }            }        }    }}

    .addMarkdownFiles(),    .addDefaultSectionTitles(),     .copyResources(),

extension Plugin where Site == Myblog{    static func addDefaultSectionTitles() -> Self{        Plugin(name:  "Default section titles"){            context in            context.mutateAllSections { section in                switch section.id {                case .posts:                    section.title = "文章"                case .about:                    section.title = "关于"                }            }        }    }}

    .addMarkdownFiles(),    .copyResources(),    .installPlugin(.addDefaultSectionTitles()),

/*每个modifier对应一个markdown语法类型。目前支持的类型有: metadataKeys,metadataValues,blockquotes,codeBlocks,headings         horizontalLines,html,images,inlineCode,links,lists,paragraphs,tables*/var bilibili = Modifier(target: .codeBlocks) { html, markdown in     // html为Ink默认的HTML转换结果，markdown为该target对应的原始内容     // firstSubstring是Publish套件中的Sweep提供的快速配对方法.    guard let content = markdown.firstSubstring(between: .prefix("```bilibili\n"), and: "\n```") else {        return html    }    var aid: String = ""    var danmu: Int = 1    // scan也是Sweep中提供另一种配对获取方式，下面的代码是获取aid:和换行之间的内容    content.scan(using: [        Matcher(identifier: "aid: ", terminator: "\n", allowMultipleMatches: false) { match, _ in            aid = String(match)        },        Matcher(identifiers: ["danmu: "], terminators: ["\n", .end], allowMultipleMatches: false) {            match,            _ in            danmu = match == "true" ? 1 : 0        },    ])    //modifier的返回值为HTML代码，本例中我们不需要使用Ink的默认转换，直接全部重写    //在很多的情况下，我们可能只是在默认转换的html结果上做出一定的修改即可    return        """        <div style="position: relative; padding: 30% 45% ; margin-top:20px;margin-bottom:20px">        <iframe style="position: absolute; width: 100%; height: 100%; left: 0; top: 0;" src="https://player.bilibili.com/player.html?aid=\(aid)&page=1&as_wide=1&high_quality=1&danmaku=\(danmu)" frameborder="no" scrolling="no"></iframe>        </div>        """}

extension PublishingStep{    static func addModifier(modifier:Modifier,modifierName name:String = "") -> Self{        .step(named: "addModifier \(name)"){ context in            context.markdownParser.addModifier(modifier)        }    }}

.addModifier(modifier: bilibili,modifierName: "bilibili"), //bilibili视频.addMarkdownFiles(),

 .installPlugin(.highlightJS()), //语法高亮插件，也是采用modifier方式，对应的也是codeBlock .addModifier(modifier: bilibili), //在这种状况下，bilibili必须在highlightJS下方。

//由于我们并不想在每次调用tag.count的时候进行计算，所以一次性将所有的tag都提前计算好//计算结果通过类属性或结构属性来保存，以便后面使用struct CountTag{    static var count:[Tag:Int] = [:]    static func count<T:Website>(content:PublishingContext<T>){        for tag in content.allTags{          //将计算每个tag下对应的item,放置在count中            count[tag] =  content.items(taggedWith: tag).count        }    }}extension Tag{    public var count:Int{        CountTag.count[self] ?? 0    }}

extension Plugin{    static func countTag() -> Self{        return Plugin(name: "countTag"){ content in            return CountTag.count(content: content)        }    }}

.installPlugin(.countTag()),

.forEach(page.tags.sorted()) { tag in       .li(       .class(tag.colorfiedClass), //tag.colorfieldClass 也是通过相同手段增加的属性，在文章最后会有该插件的获取地址              .a(               .href(context.site.path(for: tag)),               .text("\(tag.string) (\(tag.count))")               )          )  }

//创建一个Stepextension PublishingStep where Site == FatbobmanBlog{    static func makeDateArchive() -> Self{        step(named: "Date Archive"){ content in            var doc = Content()             /*创建一个Content，此处的Content是装载页面内容的，不是PublishingContext              Publish在使用addMarkdownFiles导入markdown文件时，会为每个Item或Page创建Content              由于我们是使用代码直接创建，所以不能使用markdown语法，必须直接使用HTML             */            doc.title = "时间线"             let archiveItems = dateArchive(items: content.allItems(sortedBy: \.date,order: .descending))             //使用Plot生成HTML，第二篇文章有Plot的更多介绍            let html = Node.div(                .forEach(archiveItems.keys.sorted(by: >)){ absoluteMonth in                    .group(                        .h3(.text("\(absoluteMonth.monthAndYear.year)年\(absoluteMonth.monthAndYear.month)月")),                        .ul(                            .forEach(archiveItems[absoluteMonth]!){ item in                                .li(                                    .a(                                        .href(item.path),                                        .text(item.title)                                    )                                )                            }                        )                    )                }            )            //渲染成字符串            doc.body.html = html.render()            //本例中直接生成了Page，也可以生成Item，Item需在创建时指定SectionID以及Tags            let page = Page(path: "archive", content:doc)            content.addPage(page)        }    }    //对Item按月份汇总    fileprivate static func dateArchive(items:[Item<Site>]) -> [Int:[Item<Site>]]{        let result = Dictionary(grouping: items, by: {$0.date.absoluteMonth})        return result    }}extension Date{    var absoluteMonth:Int{        let calendar = Calendar.current        let component = calendar.dateComponents([.year,.month], from: self)        return component.year! * 12 + component.month!    }}extension Int{    var monthAndYear:(year:Int,month:Int){        let month = self % 12        let year = self / 12        return (year,month)    }}

.addMarkdownFiles(),.makeDateArchive(),

extension PublishingStep{    static func makeSearchIndex(includeCode:Bool = true) -> PublishingStep{        step(named: "make search index file"){ content in            let xml = XML(                .element(named: "search",nodes:[                    //之所以将这个部分分开写，是因为有时候编译器对于复杂一点的DSL会TimeOut                    //提示编译时间过长。分开则完全没有问题。这种情况在SwiftUI中也会遇到                    .entry(content:content,includeCode: includeCode)                ])            )            let result = xml.render()            do {                try content.createFile(at: Path("/Output/search.xml")).write(result)            }            catch {                print("Failed to make search index file error:\(error)")            }        }    }}extension Node {    //这个xml文件的格式是local-search-engin确定的，这里使用Plot把网站内容转换成xml    static func entry<Site: Website>(content:PublishingContext<Site>,includeCode:Bool) -> Node{        let items = content.allItems(sortedBy: \.date)        return  .forEach(items.enumerated()){ index,item in            .element(named: "entry",nodes: [                .element(named: "title", text: item.title),                .selfClosedElement(named: "link", attributes: [.init(name: "href", value: "/" + item.path.string)] ),                .element(named: "url", text: "/" + item.path.string),                .element(named: "content", nodes: [                    .attribute(named: "type", value: "html"),                    //为Item增加了htmlForSearch方法                    //由于我的Blog的文章中包含不少代码范例，所以让使用者选择是否在检索文件中包含Code。                    .raw("<![CDATA[" + item.htmlForSearch(includeCode: includeCode) + "]]>")                ]),                .forEach(item.tags){ tag in                    .element(named:"tag",text:tag.string)                }            ])        }    }}

extension Item{    public func htmlForSearch(includeCode:Bool = true) -> String{        var result = body.html        result = result.replacingOccurrences(of: "]]>", with: "]>")        if !includeCode {        var search = true        var check = false        while search{            check = false            //使用Ink来获取配对内容            result.scan(using: [.init(identifier: "<code>", terminator: "</code>", allowMultipleMatches: false, handler: { match,range in                result.removeSubrange(range)                check = true            })])            if !check {search = false}        }        }        return result    }}

//里面的id和class由于要和javascript配合，需保持现状extension Node where Context == HTML.BodyContext {    //显示搜索结果的Node    public static func searchResult() -> Node{        .div(            .id("local-search-result"),            .class("local-search-result-cls")        )    }    //显示搜索框的Node    public static func searchInput() -> Node{        .div(        .form(            .class("site-search-form"),            .input(                .class("st-search-input"),                .attribute(named: "type", value: "text"),                .id("local-search-input"),                .required(true)                ),            .a(                .class("clearSearchInput"),                .href("javascript:"),                .onclick("document.getElementById('local-search-input').value = '';")            )        ),        .script(            .id("local.search.active"),            .raw(            """            var inputArea       = document.querySelector("#local-search-input");            inputArea.onclick   = function(){ getSearchFile(); this.onclick = null }            inputArea.onkeydown = function(){ if(event.keyCode == 13) return false }            """            )        ),            .script(                .raw(searchJS) //完整的代码后面可以下载            )        )    }}

.makeSearchIndex(includeCode: false), //根据自己需要决定是否索引文章中的代码

import Foundationimport Publishimport ShellOutextension PublishingStep where Site == FatbobmanBlog{    static func uploadToServer() -> Self{        step(named: "update files to fatbobman.com"){ content in            print("uploading......")            do {                try shellOut(to: "scp -i ~/.ssh/id_rsa -r  ~/myBlog/Output web@112.239.210.139:/var/www")                 //我是采用scp部署的,你可以用任何你习惯的方式            }            catch {                print(error)            }        }    }}

var command:String = ""if CommandLine.arguments.count > 1 {    command = CommandLine.arguments[1]}try MyBlog().publish(  .addMarkdownFiles(),  ...  .if(command == "--upload", .uploadToServer())]