#haraka

I think we're ready to ship, eh?

#430 I need to revisit as I can't remember what exactly it did etc. it can wait until 2.6.2

So I think we're good to go.

we're good to go bois.

My build setup is on my box at home so it'll have to wait :)

I'll try and do it tonight.

At some point I'd like to do a good thorough revise on the docs.

Especially look at the headers when you click on "Plugins" here: http://haraka.github.io/manual.html

Some are the plugin name, some are a description, and a couple just say "Haraka".

I fixed part of that

with a recent merge

The most reasonable looking one is connect.p0f

so we should probably try and follow that standard.

But aside from that, the tutorials need a total revamp.

but it would be much better if no .md processing were required and we published the files and let GitHub parse them with GitHub Flavored Markdown

Github don't offer any parsing on Pages.

:(

you have to upload static HTML.

Or are you suggesting an iframe to the actual page?

that's be one way

I don't know of a way to get *just* the rendered page though

without all the other cruft.

hmm, me neither. I haven't used GH pages yet

but

it smells like

you can just add a little YAML to the docs/plugins/*.md files

and then GH does the rest

Hmm interesting: "Only files with extensions .md or .markdown will be translated to HTML on a GitHub User Page"

that's good to know.

But it still means using an iframe.

but that would pull in the most recent changes too, without waiting for a release process to update them

right?

or, what exactly were you thinking of loading in that iframe?

No

because you have to put them in the Pages repo.

ah, okay.

maybe they should just live there in the first place.

nah

but they could be pulled in automatically with git-submodule

maybe

maybe

But will still require a pull/push

probably

Also I don't want the web site to reflect HEAD

I want it to reflect the current release.

(to be fair should probably also have access to old docs too, but that's too much work for now)

hmmn, yeah, /docs/r2.5.0/plugins/fcrdns

and /docs/latest/plugins/fcrdns

But for now github can do that.

aye

what I was thinking you meant by iframe was to pull in the docs directly from the repo

which would make doing docs such as "show by version" easy to implement in JS

well we'd have to use an iframe too if we put the docs on the Pages site as a .md file too.

with a little version toggle, that reloads the iframe

because otherwise you don't get the navigation stuff.

So probably not worth it.

Do Github publish their MD parser perhaps?

it's jekyll

is that a markdown parser?

that's my understanding

yup

"Jekyll takes your content, renders Markdown and Liquid templates, and spits out a complete, static website ready to be served by Apache, Nginx or another web server. Jekyll is the engine behind http://pages.github.com/, which you can use to host sites right from your GitHub repositories."

Ah but it just uses this module: https://github.com/bhollis/maruku

So I could just switch to that.

Note: http://benhollis.net/blog/2013/10/20/maruku-is-..., as it has been superceded by

I believe you are mistaken

s.add_runtime_dependency('kramdown', '~> 1.3')

Oh it loads redcarpet too.

GH Pages *used* to use maruku

I was just reading the gemfile

I was reading jekyll.gemspec

and I don't find maruku in there

ah, I see it in Gemfile, but I'm 99% sure that's legacy

there was a big deal about the switch last year

when the whole "standard markdown" kerfluffle blew up

*rolls eyes*

fucking rubyists.

Mind you JS guys are often as bad.

heh