canonical / canonical/vanilla-framework

Investigate SCSS comments parser for class reference

Open
#4,350 4 comments 0 reactions 0 assignees View on GitHub
Maintenance 🔨 P3 Triaged Priority: Low Triaged: Pragma
Dominant language
HTML
Stars
983
Forks
216
Avg merge
3d 13h
Merged PRs (30d)
3

Description

During hackaton we discovered scss-comment-parser and CDocParser

scss-comment-parser: https://github.com/SassDoc/scss-comment-parser
CDocParser: https://github.com/FWeinb/CDocParser

We could look into using one of them to parse custom annotations from the SCSS code to build class reference.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing scss-comment-parser and CDocParser, the two projects named in the issue, and determine whether either can parse the desired SCSS annotations. The repository files and tests to change are not identified; done means selecting a viable approach for generating a class reference or documenting why neither parser fits.

Written by the indexing model from the issue text.

Assessment

Tech stack
scss
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.