DavidWells / DavidWells/markdown-magic
Cool examples
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 868
- Forks
- 223
- PR merge metrics
- No merged PRs in 30d
Description
List of cool examples out in the wild that may or not may come back to the core lib as plugins 😃
- JSON to HTML table https://github.com/dineshsonachalam/markdown-autodocs#json-to-html-table
- Templating example: https://github.com/AlaskaAirlines/auro-select/blob/b3afbd1e60f7615a1ea41c21ebb90500c8a80985/scripts/generateDocs.js#L7 w/ template https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/README.md
Contributor 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.
Research direction
Start by reviewing the linked JSON-to-HTML table and templating examples, including generateDocs.js and its README template. The issue does not identify a repository file or a defined selection of examples, so clarify the intended documentation location and acceptance criteria before making changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100