search

machinekit / machinekit-docs

Machinekit website
http://www.machinekit.io
16 stars 54 forks source link

Adjusting format #200

Closed sirop closed 8 years ago

sirop commented 8 years ago

Some pieces of the previous manpage code did not render properly.

Do not know if any asciidoc format for functions was agreed upon, so let it be a proposal.

ArcEye commented 8 years ago

Can you remove the (3hm2) suffix in the title, it is irrelevant to asciidocs, just a hangover from the troff man pages.

I must get around to removing the suffixes from the contents of all the man1 and man3 files too :smile: . I have already removed it from the man1 and man3 filenames and it does not appear in any of the man9 files.

sirop commented 8 years ago

@ArcEye

Removed.

But what about common style sheet for all functions' manpages? Has such a thing been discussed?

mhaberler commented 8 years ago

not discusses so far but a great idea no web experts here - can you start such a thing?

ArcEye commented 8 years ago

Not really.

If you look at the functions, they are just conversions into asciidoc. You copied Andy Pughs functions formatting, but they were done for troff.

If you want to produce a template, that would be really useful, most of the functions need updating or even rewriting.

ArcEye commented 8 years ago

I must get around to removing the suffixes from the contents of all the man1 and man3 files too :smile: .

FYI - I am on the case - mass sed slaughter being committed as we speak

sirop commented 8 years ago

What is used behind the curtain? Asciidoc or Asciidoctor?

As the output of each is customized differently.

mhaberler commented 8 years ago

asciidoctor as per https://github.com/mhaberler/docker-jekyll-asciidoctor

feel free to inspect https://jenkins.machinekit.io/view/machinekit/job/website-preview/ and https://jenkins.machinekit.io/view/machinekit/job/website-production

I might have to turn on permissions for you to view