support markdown as a language
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 15/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- markdown
- Domain
- documentation, tooling
Research direction
The payload names no source files, so start by reading the repository's existing language support to see how the graph's node kinds are defined. The example files are README.md and docs/07_config_ini.md, where a link is the relation to capture. This is a design question, not a patch: done means the maintainers agree how headings map to nodes and links to edges, and that the question is answered in the thread first.
Written by the indexing model from the issue text.
Description
ripwire constructs a graph of source files, classes, methods/functions, variables, ...etc
and their relations
markdown can be treated as source files,
with head section as functions
and links as calls (dependencies) for example section Configurations in README.md have [config.ini file format](docs/07_config_ini.md)
although basic section navigation can be done with a skills.md that might say something like
grep -n '^#' *.md docs/*.md
sed -n '<line_from>,<line_to>p; <line_end>q' <filename>
or
find . -name '*.md' -exec grep -Hn '^#' '{}' ';'
sed -n '<line_from>,<line_to>p; <line_end>q' <filename>
but link navigation and interconnections can't be done using that simple grep.
I wonder if someone see a potential in ripwire to facilitate document navigation just like symbol navigation.
- Dominant language
- C++
- Stars
- 2.5k
- Forks
- 158
- Avg merge
- 2d 9h
- Merged PRs (30d)
- 55
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from redhat-et/ripwire
-
Difficulty 2/5 Under an hour Newbie friendliness 78/100
redhat-et/ripwire#334 · 7 comments ·
Maintainers usually reply within 1 day
-
help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
redhat-et/ripwire#68 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
redhat-et/ripwire#428 · 7 comments ·
Maintainers usually reply within 1 day
-
help wanted
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
All issues in redhat-et/ripwire
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
NVIDIA-Omniverse/PhysX#590 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/rocketmq-clients#1469 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 9 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
compiler-explorer/compiler-explorer#9402 ·
Maintainers usually reply within 1 day
-
自定义颜色添加为常用颜色Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
mg-chao/snow-apps#2227 · 2 comments ·
Maintainers usually reply within 1 day