Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/okeeblow/jekyll-beastiepress

FreeBSD community tags for Jekyll/Liquid
https://github.com/okeeblow/jekyll-beastiepress

Last synced: about 1 month ago
JSON representation

FreeBSD community tags for Jekyll/Liquid

Awesome Lists containing this project

README

        

BeastiePress for Jekyll
=======================

These Jekyll plugins add ```port```, ```pr```, and ```man``` tags through Liquid, making it easy to link to FreeBSD ports, problem reports, and manual pages.

The canonical repository for this software is hosted at [cooltrainer.org/source](https://cooltrainer.org/source/). The GitHub remote is for social features like pull requests.

Basic Setup
-----------
Install the gem:

[sudo] gem install jekyll-beastiepress

Bundler Setup
-------------
Already using Bundler to manage gems for your Jekyll project? Using Octopress? Just add to your ```Gemfile```:

gem "jekyll-beastiepress"

Enable
------
Create a plugin file within your Jekyll project's ```_plugins``` directory:

# _plugins/jekyll-beastiepress.rb
require "jekyll-beastiepress"

Usage
-----

### man
Syntax:

{% man [section] command ['release'] ['link text'] ['title text'] %}

Examples:

{% man 8 lpc "FreeBSD 8.1-RELEASE" "the manpage" "Section 8 of the lpc manpage" %}
{% man 8 lpc "FreeBSD 8.1-RELEASE" %}
{% man lpc %}

Output:

the manpage
lpc(8)
lpc

### port
Syntax

{% port portname ['link text'] ['title text'] %}

Example:

{% port www/subsonic "A link to www/subsonic on Freshports" "Subsonic" %}

Output:

Subsonic

### pr
Syntax:

{% pr [category/]prnumber ['link text'] ['title text'] %}

Example:

{% pr ports/151677 'the fix' 'Filename handling fix for cuetools.sh' %}
{% pr ports/151677 %}

Output:

the fix
ports/151677