bitovi / bitovi/documentjs

Tag for examples/demo pages

Open
#141 1 comment 0 reactions 0 assignees View on GitHub
RFC
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

Right now, it's pretty difficult to deal with demo pages. Relative paths and versioning don't work well (see #116). There is no way to add an example as a docObject, and it's very difficult to use examples when they are part of a dependent project (like for DocumentCSS.com). For live style guides, it was requested that examples could be done inline: #118.

To bring demos up to the standard of other tags, this is the minimum feature set:
- [ ] `@example` tag (or something similar) that generates something similar to a `@page`
- [ ] Template specifically for `@example` tags
- [ ] `@iframe` and `@demo` tags can accept a docObject or a path

Nice-to-haves:
- [ ] Configuration of static resource dependencies
- [ ] Rich inline processing (see #118)

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.