Shortcodes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 10
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Markdown content should not necessarily be one big chunk. We might want to include the concept of `shortcodes` with which you can insert custom, site-defined blocks into the content.
A key aspect is that the shortcodes should be easy to insert in the content and be decently parsed by Markdown processors that don't support shortcodes (i.e. they shouldn't look like shit on Github)
Contributor guide
No contributing guide indexed for this repository
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 tracing Marcel's Markdown content processing and how site-defined blocks could be represented. Define a shortcode syntax that is easy to insert, parsed by Marcel, and remains reasonably readable when rendered by Markdown processors without shortcode support.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- content
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100