Code Monkey home page Code Monkey logo

jekyll-beastiepress's Introduction

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. 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:

<a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=8&manpath=FreeBSD 8.1-RELEASE' title='Section 8 of the lpc manpage'>the manpage</a>
<a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=8&manpath=FreeBSD 8.1-RELEASE' title='man lpc(8) from FreeBSD 8.1-RELEASE'>lpc(8)</a>
<a href='http://www.freebsd.org/cgi/man.cgi?query=lpc&sektion=&manpath=' title='man lpc'>lpc</a>

port

Syntax

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

Example:

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

Output:

<a href='http://freshports.org/www/subsonic' title='A link to www/subsonic on Freshports'>Subsonic</a>

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:

<a href='http://freshports.org/www/subsonic' title='Filename handling fix for cuetools.sh'>the fix</a>
<a href='http://www.freebsd.org/cgi/query-pr.cgi?pr=ports/151677' title='Problem Report ports/151677'>ports/151677</a>

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.