Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: make clear that type selectors are just examples #15

Closed
wants to merge 2 commits into from
Closed

docs: make clear that type selectors are just examples #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
85afaf2
Update readme.md
ooker777 Aug 26, 2024
124c801
docs: add full list of node types
ooker777 Aug 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ Yields:
```

## Support

Note: `blockquote`, `paragraph` are just examples of type selectors, not the only types it can selects. See [this full list of node types](https://github.com/syntax-tree/mdast?tab=readme-ov-file#contents)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ooker777! 👋

There are some broader question that should probably be discussed before updating the docs.

  1. How familiar are you with CSS? Are more links to general CSS docs needed?
  2. How familiar are you with the different unified syntax trees? (https://unifiedjs.com/learn/) This project works across all of them, not just one.

There is probably room to improve the documentation, it would be good in a way that is general enough to represent a variety of use cases, not one very specific use case.

A few thoughts on the example here.

  1. This package implements CSS selectors, CSS is an entire language, it feels off trying to explain what selectors are here.
  2. unist-util-select works on any unist compatible tree, including mdast, hast, nlcst dotast, xast, ntast, and more. It feels off referencing only one.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Just for my background, I have made 2 small scale webapp with Deno Fresh. In CSS I have experience in Tailwind and have implement an UI component lib. But I don't have much experience working on vanilla CSS
  2. I am new with the syntax trees, and while I have read the docs and get some basic concepts, I don't think I have had a good mental model on how the whole project works

More are provided in the comment below

* [x] `*` (universal selector)
* [x] `,` (multiple selector)
* [x] `paragraph` (type selector)
Expand Down
Loading