bitovi / bitovi/documentjs

Demo option for showing both code and demo at the same time

Open
#195 2 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

Currently, `@demo` always generates a tab interface.
![screen shot 2015-08-26 at 9 55 13 am](https://cloud.githubusercontent.com/assets/326843/9496992/9273d3de-4bd8-11e5-93f1-60018b8a5539.png)

Would be nice to have the option to force it to display both, one on top of the other, like this example from Bootstrap. This is more useful for short / small examples of code snippets.
![screen shot 2015-08-26 at 9 56 12 am](https://cloud.githubusercontent.com/assets/326843/9497011/b4cc9718-4bd8-11e5-929a-41f6a4ded3e2.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the implementation and tests for the `@demo` directive and how its tab interface is generated. Add an option that renders the code and demo together vertically, and verify that the existing tab behavior remains unchanged when the option is not used.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.