plerd, Ultralight Dropbox友好的基于 Markdown的博客

分享于 

14分钟阅读

GitHub

  繁體 雙語
Ultralight Dropbox-friendly Markdown-based blogging.
  • 源代码名称:plerd
  • 源代码网址:http://www.github.com/jmacdotorg/plerd
  • plerd源代码文档
  • plerd源代码下载
  • Git URL:
    git://www.github.com/jmacdotorg/plerd.git
    Git Clone代码到本地:
    git clone http://www.github.com/jmacdotorg/plerd
    Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/jmacdotorg/plerd
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
    
    Plerd

    Plerd是一个为 Markdown 风扇提供的轻量级博客平台,可以在( 但不需要) Dropbox中运行良好。

    它允许你像添加和修改单个文件夹中的Markdown 文件一样轻松地撰写和维护博客文章。 Plerd基于这个文件夹的内容创建一个完全 static 网站,每当这个内容改变时自动更新站点。

    命令行目

    通过将 Markdown 文件添加到指定的博客源目录,Plerd允许blogger向他们的博客发布新帖子。 通过在Dropbox中混合,这个目录可以在他们的本地机器上运行。 它们还可以通过更新所述文件更新文章,并通过删除或者移动相同文件夹中的文件发布。

    生成的网站包含仅包含 static 文件的单个目录。 这些内容包括每个帖子的一个"永久链接"页面,一个最近发布的日志页面,一个归档页面( 以火球的方式。),以及 Atom 和JSON提要文件格式的联合文档。 所有这些都是由简单的。可以定制的模板构建的。

    就是这样这就是Plerd所做的。

    如果你有时间和倾斜度,你可以看的一个 20-minute 演示,关于我创建Plerd的理由。

    项目状态

    Plerd被释放并稳定。 它仍然有足够的改进空间,我欢迎社区反馈和补丁建议,但它将继续执行。

    设置

    安装

    这里版本的Plerd旨在直接从自己的源目录运行,而不是从系统上正式安装的位置运行。 然而,你可以能需要安装它的各种库依赖项,然后需要进行一些进一步的配置和定制。

    要安装 Plerd,请从Plerd知识库( 包含这里文件的目录自述文件)的顶层运行以下命令:

    
    curl -fsSL https://cpanmin.us | perl - --installdeps. 
    
    
    
    

    尽管Plerd模块需要安装一组Perl模块,但这应该会很。 需要几分钟时间。 完成后,Plerd将准备好进行配置。

    配置

    为plerd创建一个新目录。 然后,创建这些子目录的inside:

    • source: 这将基于博客源文件保存你的降价。
    • templates: 保存你的博客模板。
    • docroot: 将保存你的博客 docroot,准备由你选择的web server软件提供服务。

    你可以随意添加这里目录中的其他文件或者目录,如果你希望(。drafts 文件夹,可能)。 Plerd会很高兴地忽略它们。

    另外,你可以在你的文件系统 上选择3 个目录,以提供这些目的。 只要确保任何用户运行的plerd进程都具有对源代码和docroot目录的写访问权限。

    conf/plerd_example.conf 复制到 conf/plerd.conf,然后将它的更新为最适合你的博客。

    • path 属性设置为你在第一步中创建的目录的完整路径。

      ( 如果选择选择不同目录的备用路径,则设置 source_pathpublication_pathtemplate_path 目录,就像 conf/plerd_example.conf 中注释出来的行一样)。

    • 根据所提供的示例,设置其他属性应该是明显的。

    将这里 templates 目录的内容复制到第一步创建的新 templates 子目录中。

    这些是你可以定制的示例模板,你可以根据需要定制。 它们是使用模板工具包( ) 来呈现的。 你不能更改这些模板文件的名称,但是你可以添加主temlates将通过调用的新子模板文件,[ % 包括 %] 指令,等等。

    配置你选择的服务器,以便它将同步的docroot 子目录( 作为第一步的一部分) 视为你新的博客 docroot。

    Plerd不提供web服务器;它只生成 static & XML文件,可以为其他进程提供服务。

    用法

    正在运行 Plerd

    Plerd包括两个命令行程序,这两个程序都在分发目录的这里 bin 中找到:

    • 根据源目录目录的内容,英镑在plerd目录的docroot中创建新网站。

      运行这里程序( 没有参数) 最初填充博客的docroot,并在任何它的他时候手动重新生成博客文件。

    • plerdwatcher 运行一个守护进程,监控synced同步的源代码目录,以便在必要时重新发布文件。

      ,这就是魔术发生的地方。 如果你的博客服务器进程在你的服务器上运行,那么你对博客目录的任何更改都将立即更新你的博客 static 文件。

      通过这里命令( 假设你的工作目录是plerd目录的顶级) 启动 plerdwatcher:

      
       bin/plerdwatcher start
      
      
      
      

      它还接受动词的stoprestartstatus,以及中列出的所有命令行选项( 见清单1 )。

    撰写文章

    在你的博客目录之外的地方创建一个新的Markdown 文件,只需创建一个新的文件就可以了。 你可能希望在任何时候都能看到这个文件,只要文件名在或者 .md 中结束,那么你就可以使用它。

    你还必须给你的帖子一个标题,在你准备发布它之前。 通过使用条目的第一行说 title: [whatever],后跟两个换行符,然后按照文章的主体来定义标题。

    例如,有效的ready-to-publish源文件可以能被称为 today.markdown,它可以包含以下内容:

    
    title: My day today
    
    
    
    I had a pretty good day today. 
    
    
    
    I hung out at [the coffee shop](http://empireteaandcoffee.com). Then I went home.
    
    
    
    Well, that's all for now. Bye bye.
    
    
    
    

    发布日志

    要发布帖子,只需将它移动到plerd目录的。 ( 注意不要覆盖可能具有相同名称的较旧的日志文件。)

    Plerd一旦注意到新文件,就给文件一个记录它的发布日期和时间的时间戳。 这里时间戳将出现在它的自己的行之后,标题行之后。

    通常,Plerd将发布时间设置为你将文件添加到源目录时的时间。 Plerd可以识别这里规则的两个例外:

    • 如果手动给你的time: 时间戳,它是在W3C日期时间格式,那么Plerd将保留这个时间戳单独。

    • 在post日期 out 和中,你将在昨天或者更早的日期中( 比如 ) 中包含 post and。 然后,Plerd将把日志的时间戳设置为该日期的午夜。 这使你可以在--有用的情况下批量回溯许多文章,用于填充新的写入博客。

    ( 注意,Plerd假设你使用的文本编辑器足够灵活,并且从外部进程中添加了额外的行。)

    一旦它准备好了源文件,Plerd将更新博客。 它将为新条目创建一个新的HTML文件,并从 archive.html 页面添加一个指向它的链接。 它还会出现在每个它的他条目的最近发布的侧边栏中,以及 Atom 和JSON提要文档( 除非你决定通过在文件中指定自己的日期属性来手动回溯条目)。

    更新或者删除日志

    要更新博客文章,只需编辑源 Markdown 文件,在源目录中。 你所做的任何更改都会立即更新你所发布的博客

    要取消发布博客,只需将它的移出同步的源目录--或者删除它。

    使用Plerd与 Dropbox

    Plerd喜欢 Dropbox ( 实际上,它从设计的开始就有了Dropbox的亲和力。) !

    要让Plerd与Dropbox协同工作,只需在同步的收存箱文件夹中将它的工作目录设为( 包含源。docroot和模板子目录的),并在你的配置文件中指定这里文件夹的本地路径。

    只要你使用和编辑文件,就可以创建。更新和删除博客帖子,不管你使用的是什么计算机,只要它能访问该Dropbox文件夹。

    通过在文本编辑器中单击鼠标右键,并在文本编辑器中单击鼠标右键,不要直接与服务器( 或者,使用Plerd软件本身) 交互,以这种方式撰写和编辑博客帖子,从而在你喜爱的Coffee 编辑器中编辑博客文章。 什么。 什么。

    高级使用

    定制模板

    关于模板文件以及如何定制它们的简短指南,请参见GitHub上的wiki。

    用户定义的属性

    你可以添加你想要的任何属性,然后通过名为 attributes的哈希代码从模板中引用它们。 例如如果post的元数据如下所示:

    
    title: Example of user-defined attributes
    
    
    byline: Sam Handwich
    
    
    
    

    然后可以引用 post.attributes.bylinepost.tt 模板文件中获取该值,即使"署名"不是Plerd可以识别的属性。 ( 如果一个模板引用了一个post文件源没有定义的属性键,它将只返回一个空值。)

    社会媒体元标记

    你可以将Plerd的Open和 Twitter 卡添加到每个帖子中,从而在你的博客文件配置中定义一些额外属性。 这将允许像 Facebook。Twitter 和Slack这样的服务在显示链接时显示你的blogposts的小摘要。

    这些博客配置选项( 所有选项) 包括:

    • 英镑 twitter_id: 如果存在,那么Plerd将尝试向每个post附加 Twitter 卡元数据,该元数据与给定的Twitter 用户名关联。 ( 没有领先的'@',是的,我知道。 它使YAML解析器变得混乱。 抱歉。

    • 如果存在英镑,那么Plerd将尝试将开放图元数据附加到每一个帖子,与给定的Facebook服务器关联。

    • 如果当前图像不存在,则Plerd将使用这里URL作为默认图像的位置,以便在任何未定义它的自身的图像的日志中使用该 URL。

      如果不存在,则Plerd将不会为任何缺少图像属性的帖子生成任何社会媒体元数据。

    • image_alt: image 属性所引用的图像的文本描述。 ("alt" <img> 标签中的属性等效。) Plerd将只留下这个空白,如果你不自己定义它。

    若要查看所有 上面的示例,请参见文件 conf/plerd_example.conf

    按照描述 上面 配置博客后,你可以将这些属性添加到任何帖子中:

    • 描述: 这篇文章的简要摘要。

      如果未定义,则Plerd将尝试使用 post ( 删除所有标记后) 文本的第一段作为post的描述。

    • 图片: 在社交媒体链接中与这里帖子关联的图像的URL。 ( 这可以指图像,也可以通过一个 HTML <img> 标记出现在你的文章中,但它不必。)

      如果没有定义,那么Plerd将使用博客镜像的configuration配置指令 。 如果也是未定义的,那么将不会为这个帖子生成任何社会化媒体元数据。

    • image_alt: image 属性所引用的图像的文本描述。 ("alt" <img> 标签中的属性等效。) Plerd将只留下这个空白,如果你不自己定义它。

    关于编码的注释

    Plerd假定所有源文件和模板文件都编码为 UTF-8.

    支持

    要报告 Bug 或者文件请求请求,请访问知识库的 GitHub。

    Plerd在它的创建者的网站上有一个主页。

    你可以讨论或者询问关于Plerd的问题,在 Freenode的#plerd 频道。 plerd和维护者的作者将作为 jmac 挂起,并且很愿意更早或者更早地响应查询。

    工作时查看 Plerd

    这个软件支持Jason的博客 Jason,它是为。

    Credits

    Plerd是 Jason McIntosh ( jmac@jmac.org )。 我想听听关于Plerd你愿意分享的任何想法。

    这里库包含由 Jon seed的图像"信封"设计,以及 useiconic.com的图像"rss"设计。 这两个都是通过一个创作共享属性 3.0美国的许可证共享的,并通过来完成这个项目的名词项目。


    BASE  MARK  Markdown  blog  友元  Dropbox  
    相关文章