mobify / pikabu

Off-Canvas flyout menu
http://mobify.github.io/pikabu/
MIT License
453 stars 51 forks source link

Pikabu 2.0: how to mark up the body content #51

Closed vmarta closed 8 years ago

vmarta commented 9 years ago

The readme for Pikabu 2.0 needs to indicate what the minimum expected markup that works.

Currently, the readme essentially asks you to do this:

<div id="yourPikabu" hidden>
    Your pikabu content
</div>
<script>$('#yourPikabu').pikabu()</script>

But that's not enough.. it doesn't say how to mark up the body content too. I had to add the following markup in current project:

<div class="pikabu">
    <div class="pikabu__container">
        // header, main, footer would go here
    </div>
</div>

What is supposed to be the markup for it? Thanks.

donnielrt commented 8 years ago

@vmarta do you know if we're using Pikabu 2.0 in any projects?