bitovi / bitovi/documentjs

Ignore mustache helpers inside code blocks

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

Description

When documenting Stache or Mustache helpers you currently have to put a `\` in front of them in order for the builder to try to process them. This is true even inside code blocks.

```
// Use the calendar helper to insert a calendar with this syntax:
\{{calendar}}
```

This is problematic for using README.md as the main API page or home page (as brought up in #155) because on Github, the README would show the backslashes.

Ignoring helpers inside code blocks would probably be the best solution to this.

This should also be documented. Probably somewhere in here: http://localhost:8080/docs/documentjs.generators.html.html
It won't matter if it's buried since it's a niche use case.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the README.md example and tracing how the builder processes helpers inside fenced code blocks. Check the documentation at documentjs.generators.html.html for the appropriate place to describe the behavior. Done means mustache helpers in code blocks render without backslashes, while the behavior is documented.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.