Update docs for newcomers

[wooorm]

Initial checklist

• [x] I read the support docs
• [x] I read the contributing guide
• [x] I agree to follow the code of conduct
• [x] I searched issues and couldn’t find anything (or linked relevant results below)
• [x] If applicable, I’ve added docs and tests

Description of changes

This improves the docs, focussing on newcomers. The goal is to make it easier for folks without background information on unified/remark/asts/etc to figure out what a project is and if they need it or something else.

I thought I’d kick something off but the plan is for similar changes to go out to all unified readmes.

Related-to: unifiedjs/unified#168.

/cc @nemo-omen

[codecov-commenter]

Codecov Report

Merging #6 (29ddc60) into main (86376c7) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##              main        #6   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines           36        36           
=========================================
  Hits            36        36           

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 86376c7...29ddc60. Read the comment docs.

[wooorm]

@nemo-omen I’ve significantly reworked the docs some more. The rendered view is here: https://github.com/remarkjs/remark-directive/blob/docs/readme.md. This adds sections on examples, syntax, syntax tree, types, and compatibility. It also adds deno and browsers to the install section. Could you check again?

The plan is to apply similar changes to all projects.

/cc @ChristianMurphy @remcohaszing

[github-actions[bot]]

Hi! This was closed. Team: If this was merged, please describe when this is likely to be released. Otherwise, please add one of the no/* labels.