Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MkDocs migration #31

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

MkDocs migration #31

wants to merge 1 commit into from

Conversation

fperrad
Copy link
Contributor

@fperrad fperrad commented Sep 15, 2016

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/

@arsv
Copy link
Owner

arsv commented Oct 2, 2016

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants