perl-cross icon indicating copy to clipboard operation
perl-cross copied to clipboard

MkDocs migration

Open fperrad opened this issue 9 years ago • 1 comments

MkDocs is a great tool, see http://www.mkdocs.org

  • write the documentation source (Markdown) in master branch:

    mkdocs.yml docs/*.md

  • generate & push the generated stuff (HTML, ...) in gh-pages branch:

    $ mkdocs gh-deploy --clean

  • see the result in my fork at https://fperrad.github.io/perl-cross/

fperrad avatar Sep 15 '16 16:09 fperrad

Sorry, left this out. Completely unsure what to do about this.

I do like the idea of moving to markdown, and maybe moving them back to the main tree. However I don't like the output mkdocs produce, it's not clear what to do about gh-pages (automated commits?), and the docs will need some updates to work like this (but the docs need overhaul anyway).

Tried pandoc instead, but that requires way more scripting that current gh-pages to get anything usable. Github apparently has some Jekyll integration but it's not clear it's going to be any better.

Merged into https://github.com/arsv/perl-cross/tree/mkdocs for now.

arsv avatar Oct 02 '16 20:10 arsv