Add mdast-util-from-adf to list of utilities
#40
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds the mdast-util-from-adf package to the list of utilities in the readme (https://github.com/bitcrowd/mdast-util-from-adf). The mdast-util-from-adf package is a utility to build a mdast syntax tree from Atlassian Document format (ADF). ADF is a rich text format which Atlassian uses in most of its products (e.g. Jira, Confluence, etc.). See: https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/ ADF is "close" to Markdown but not 100%.
github-actions
bot
added
👋 phase/new
wooorm
approved these changes
Feb 22, 2022
wooorm
changed the title
mdast-util-from-adf to list of utilities
|
nice, thanks! |
This comment has been minimized.
This comment has been minimized.
|
Maybe an idea to add a little movie/gif to |
You're the 2nd person to request that. Moving it up on my list of things to do 🚀 Thanks 💚 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Initial checklist
Description of changes
Hi 👋
First off, thanks a ton for this great tool 💚
This PR adds the mdast-util-from-adf package to the list of utilities in the readme.
The
mdast-util-from-adfpackage is a utility to build a mdast syntax tree from Atlassian Document format (ADF). ADF is a rich text format which Atlassian uses in most of its products (e.g. Jira, Confluence, etc.). It is "close" to Markdown, but not 100%. Combining this utility package withmdast-util-to-markdownallows escaping Atlassian's proprietary gardens into the freedom of widely used formats 🦋.Background: My former colleague @pmeinhardt wrote the package to parse Jira tickets into Git commit messages and format them reasonably. It is used as part of a browser extension for Git conventions (https://github.com/bitcrowd/tickety-tick).
Maybe this package is helpful for others who are struggling with ADF as well ☮️