sourcejs/Source

Don't have all spec markup using markdown when not using a .md file.

Open

#219 opened on Apr 29, 2016

View on GitHub
 (7 comments) (0 reactions) (0 assignees)JavaScript (49 forks)batch import
good first contributionhelp wanted

Repository metrics

Stars
 (552 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

When I use the index.src.html spec file and use I can't understand from the examples how I add the:

.source_info .source_warn .source_doc .source_a_d .source_a_s .source_hl .source_a_hl

that are defined in https://sourcejs.com/docs/spec/

I tried doing a:

``` info
Text in here
\```

But it didn't work (I really wish there was an easy way to add markdown into markdown, excuse the \ )

also would it be better if they were in the format of .sourcejs-info, sourcejs-warn, etc? Which also begs the question should the code blocks be sourcejs-css instead of src-css to keep it all consistent? It would be great if somebody like a BA with no coding knowledge would be able write all the spec text using MD

Contributor guide

Research direction
Investigate how Source processes spec files and implement support for .source info, .source warn, etc. classes in non .md files by extending the markdown parser or adding custom blockquotes.
Tech stack
javascript
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70