`
deepinmind
  • 浏览: 451427 次
  • 性别: Icon_minigender_1
  • 来自: 北京
博客专栏
1dc14e59-7bdf-33ab-841a-02d087aed982
Java函数式编程
浏览量:41621
社区版块
存档分类
最新评论

使用StaGen来生成静态网站

 
阅读更多
译注:StaGen是一个功能极其简单的静态站点生成器,因此它非常容易上手,同时它还是用Java 8写的,有兴趣的话可以看下它的源代码。当然我个人还是比较喜欢Jekyll

在没有StaGen之前,我一直都在用RapidWeaver来管理我的网站 WizTools.org。RapidWeaver生成的文本格式真的让人很抓狂,这个软件浪费了我太多时间。StaGen的诞生解决了这些问题。我连夜完成了第一个版本。第二天就把我的网站WizTools.org给迁移到StatGen上面了。StaGen的设计目标就是希望能让只有少数几个页面的简单站点的开发和管理变得更容易一些。出于这个的考虑,我选择了markdown作为文档格式,StringTemplate作为内容模板,并使用JSON来存储配置信息。

目录结构

StaGen管理的网站项目需要遵循如下的目录结构:

.
`-- content
|   |-- index.md
|   |-- other.md
`-- config
|   |-- other.json
|-- master.json
`-- static
|   |-- my.css
`-- template
|   |-- index.st
|   |-- other.st


各个文件夹的作用如下:
  • content: 这个文件夹用来存储markdown格式的文档。生成的网站中会为每篇文章都单独生成一个HTML文件。content下面的子目录会被StaGen忽略。
  • config: 每个页面都可以有一些单独的配置信息。配置信息是用JSON格式来存储的。文件名必须和content中的文件名匹配。
  • master.json:这是主配置文件。里面存储了网站全局的配置信息。
  • static: 网站中用到的静态资源文件,比如.js,.css以及图片等。
  • template: StringTemplate 4模板会放在这个目录下。

  • StaGen是如何工作的

    StaGen引擎处理的顺序是这样的:

    1. 加载主配置文件master.json
    2. 将静态资源文件拷贝到目标文件夹(网站生成的时候会自动创建一个叫target的文件夹)
    3. 对于content目录下的每一个markdown文件:
         加载对应的配置信息(下节中会有介绍)
         将配置信息应用到对应的模板上,并把结果的HTML文件输出到目标文件夹

    加载配置

    配置信息是一个JSON类型的map:

    {
    "title": "My Site Title",
    "activities": ["Dance", "Jump", "Shout"]
    }
    


    注意,key必须是字符串,值可以是任意类型的。

    前面已经提到过,站点的全局配置是master.json。StaGen在一开始的时候便会加载这个配置文件。当处理到每一篇文章时(比如index.md),StaGen会尝试从config/index.json中加载对应的配置信息。它会覆盖掉主配置文件中的配置信息。也就是说,如果你已经在master.json和config/index.json中都定义了标题,当渲染index.md时,使用的是config/index.json里面的配置。如果config/index.json文件不存在,也无所谓——那就用master.json里面的配置好了。

    模板渲染

    StaGen使用的是StringTemplate作为模板。下面是一个简单的模板,它用到了前面提到的JSON配置信息:

    <html>
    ...
    <title>$titleprebuffer_2lt;/title>
    ...
    [list=1]
    $activities: {activity|
    [*]$activityprebuffer_2lt;/li>
    }$
    [/list]
    ...
    $_content$
    ...
    </html>
    


    $_content$就是markdown文件渲染出来的HTML。

    模板渲染遵循如下的规则:

    1. 尝试按文章的名字加载模板,比如content.md,StaGen引擎会加载other.st。
    2. 如果没有指定专门的模板,则使用默认的index.st模板。因此你要确保你的项目中确实有一个index.st模板。

    模板内嵌套模板

    你可以在.st文件里再包含一个别的模板,比如你有一个ga.st(ga->Google Analytics)文件,要引入到主模板文件index.st中。在index.st里面你可以这么写:

    $ga()$
    


    index.st里面会包含ga.st渲染后的内容。需要注意的是,index.st中的所有变量对引入的模板都是可见的。

    StaGen的使用

    StaGen是以一个jar包的形式发布的。想获取这个工具的帮助信息的话:

    java -jar ~/stagen-VER-full.jar -h
    


    从项目里生成站点:

    java -jar ~/stagen-VER-full.jar gen
    


    上述命令将会在target目录中生成一个静态网站。

    想清除target目录的话:

    java -jar ~/stagen-VER-full.jar clean
    


    如果你刚开始用StaGen,想创建一个新的项目结构:

    java -jar ~/stagen-VER-full.jar init
    


    总结

    StaGen故意设计得非常简单。我自己不会用它来管理太复杂的站点。它不像别的静态网站生成器那样能支持博客或者主题。我相信,StaGen不支持这些特性,这也正是它的过人之处。

    原创文章转载请注明出处:http://it.deepinmind.com

    英文原文链接
    2
    1
    分享到:
    评论

    相关推荐

      iDRW:使用定向随机游走的基于网络的多层路径活动推断

      exp :RNA-Seq基因表达谱cna :CNV配置文件meth :DNA甲基化谱clinical :临床矩阵(7个变量- time (总生存天数), status (事件状态), age , gender , stageM , stageN , stageT )2.获取多

      btg_128128_FPC_stagennm_btg_128128-51驱动_btg749_

      通常,"stagen"在电子领域可能会与阶段或者步骤有关,但具体含义需要更多上下文来确定。 4. **btg_128128-51驱动**:这里的"51"可能指的是51系列单片机,如常用的8051,这是微控制器的一种,常用于控制LCD显示。...

      linux基础进阶笔记

      linux基础进阶笔记,配套视频:https://www.bilibili.com/list/474327672?sid=4493093&spm_id_from=333.999.0.0&desc=1

      IMG20241115211541.jpg

      IMG20241115211541.jpg

      Sen2_ARI_median.txt

      GEE训练教程——Landsat5、8和Sentinel-2、DEM和各2哦想指数下载

      毕业设计&课设_基于 flask-whoosh-jieba 的代码,涉及文件管理及问题修复.zip

      该资源内项目源码是个人的课程设计、毕业设计,代码都测试ok,都是运行成功后才上传资源,答辩评审平均分达到96分,放心下载使用! ## 项目备注 1、该资源内项目代码都经过严格测试运行成功才上传的,请放心下载使用! 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习,也适合小白学习进阶,当然也可作为毕设项目、课程设计、作业、项目初期立项演示等。 3、如果基础还行,也可在此代码基础上进行修改,以实现其他功能,也可用于毕设、课设、作业等。 下载后请首先打开README.md文件(如有),仅供学习参考, 切勿用于商业用途。

      基于springboot家政预约平台源码数据库文档.zip

      基于springboot家政预约平台源码数据库文档.zip

      Ucharts添加stack和折线图line的混合图

      Ucharts添加stack和折线图line的混合图

      基于springboot员工在线餐饮管理系统源码数据库文档.zip

      基于springboot员工在线餐饮管理系统源码数据库文档.zip

      2015-2021年新能源汽车分地区、分类型、分级别销量逐月数据和进出口数据-最新出炉.zip

      新能源汽车进出口数据 1、时间跨度:2018-2020年 2、指标说明:包含如下指标的进出口数据:混合动力客车(10座及以上)、纯电动客车(10座及以上)、非插电式混合动力乘用车、插电式混合动力乘用车、纯电动乘用车 二、新能源汽车进出口月销售数据(分地区、分类型、分 级别) 1、数据来源:见资料内说明 2、时间跨度:2014年1月-2021年5月 4、指标说明: 包含如下指标 2015年1月-2021年5月新能源乘用车终端月度销量(分类型)部分内容如下: 新能源乘用车(单月值、累计值 )、插电式混合动力 月度销量合计(狭义乘用车轿车、SUV、MPV、交叉型乘用车); 月度销量同比增速(狭义乘用车轿车、SUV、MPV、交叉型乘用车); 累计销量合计(狭义乘用车轿车、SUV、IPV、交叉型乘用车); 累计销量同比增速(狭义乘用车轿车、SUV、MPV、交叉型乘用车); 累计结构变化(狭义乘用车轿车、SUV、IPV、交叉型乘用车); 2015年1月-2021年5月新能源乘用车终端月度销量(分地区)内容如下: 更多见资源内

      中心主题-241121215200.pdf

      中心主题-241121215200.pdf

      蓝奏云下载链接与密码整理

      内容概要:本文档提供了多个蓝奏云下载链接及其对应解压密码,帮助用户快速获取所需文件。 适合人群:需要从蓝奏云下载文件的互联网用户。 使用场景及目标:方便地记录并分享蓝奏云上文件的下载地址和密码,提高下载效率。 阅读建议:直接查看并使用提供的链接和密码即可。若遇到失效情况,请尝试联系上传者确认更新后的链接。

      Javaweb仓库管理系统项目源码.zip

      基于Java web 实现的仓库管理系统源码,适用于初学者了解Java web的开发过程以及仓库管理系统的实现。

      Python-文件重命名-自定义添加文字-重命名

      资源名称:Python-文件重命名-自定义添加文字-重命名 类型:windows—exe可执行工具 环境:Windows10或以上系统 功能: 1、点击按钮 "源原文"【浏览】表示:选择重命名的文件夹 2、点击按钮 "保存文件夹"【浏览】表示:保存的路径(为了方便可选择保存在 源文件中 ) 3、功能①:在【头部】添加自定义文字 4、功能②:在【尾部】添加自定义文字 5、功能③:输入源字符 ;输入替换字符 可以将源文件中的字符替换自定义的 6、功能④:自动加上编号_1 _2 _3 优点: 1、非常快的速度! 2、已打包—双击即用!无需安装! 3、自带GUI界面方便使用!

      JDK8安装包,为各位学习的朋友免费提供

      JDK8安装包

      Centos-7yum的rpm包

      配合作者 一同使用 作者地址没有次下载路径 https://blog.csdn.net/weixin_52372189/article/details/127471149?fromshare=blogdetail&sharetype=blogdetail&sharerId=127471149&sharerefer=PC&sharesource=weixin_45375332&sharefrom=from_link

      setup_python_geospatial_analysis.ipynb

      GEE训练教程

      毕业设计&课设_文成公主微信公众号全栈工程,含技术栈、架构及部署流程等内容.zip

      该资源内项目源码是个人的课程设计、毕业设计,代码都测试ok,都是运行成功后才上传资源,答辩评审平均分达到96分,放心下载使用! ## 项目备注 1、该资源内项目代码都经过严格测试运行成功才上传的,请放心下载使用! 2、本项目适合计算机相关专业(如计科、人工智能、通信工程、自动化、电子信息等)的在校学生、老师或者企业员工下载学习,也适合小白学习进阶,当然也可作为毕设项目、课程设计、作业、项目初期立项演示等。 3、如果基础还行,也可在此代码基础上进行修改,以实现其他功能,也可用于毕设、课设、作业等。 下载后请首先打开README.md文件(如有),仅供学习参考, 切勿用于商业用途。

      基于springboot交通感知与车路协同系统源码数据库文档.zip

      基于springboot交通感知与车路协同系统源码数据库文档.zip

      基于springboot+vue 雅妮电影票购买系统源码数据库文档.zip

      基于springboot+vue 雅妮电影票购买系统源码数据库文档.zip

    Global site tag (gtag.js) - Google Analytics