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.

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

Add enter, exit terms #25

Merged
merged 1 commit into from May 27, 2019
Merged

Add enter, exit terms #25

merged 1 commit into from May 27, 2019

Conversation

wooorm
Copy link
Member

@wooorm wooorm commented May 27, 2019

Closes GH-24.

@wooorm wooorm merged commit 1fc013b into master May 27, 2019
@wooorm wooorm deleted the enter-exit branch May 27, 2019 20:11
Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

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

Is this terminology we want to include in this repo?
Or is this something that should be linked to an external resource?
If the terminology is kept here, should it also be added to mdast, hast, and nlcst? Maybe remark, rehype, and retext?

@wooorm
Copy link
Member Author

wooorm commented May 27, 2019

Thanks for checking in!

Yes, I’m going with your last paragraph. I laid the problem out a bit in the issue: I think that adding more back-and-forth references is good.

Although, for the external resource: I can see the glossary becoming rather big, in the future it could be a different project?

@wooorm
Copy link
Member Author

wooorm commented May 27, 2019

(for these terms, it arose because hast has a concept of “spaces” that are automatically toggled when entering and exiting, such as described here: https://github.com/syntax-tree/hast-util-to-parse5#space and in other places)

@ChristianMurphy
Copy link
Member

I can see the glossary becoming rather big, in the future it could be a different project?

I was thinking the same thing.
With the amount of similarity between the projects, and the amount of terminology and CS theory behind it.
Having a project to centralize the documentation could be good.

@wooorm
Copy link
Member Author

wooorm commented May 27, 2019

Having a project to centralize the documentation could be good.

This does align with my goals a) everything is its own module and b) being welcome to other projects!
I, however, do not have a CS degree so I don’t know much about trees other than working on them the last years 😅

Would this be something like the initial section of the babel plugin handbook? Do you have other resources?

@ChristianMurphy
Copy link
Member

Would this be something like the initial section of the babel plugin handbook?

Exactly like that.

Do you have other resources?

MIT OpenCourseware, compiler design books (more), wikipedia

@ChristianMurphy
Copy link
Member

There are also tools for creating and organization larger documentation sites.
https://www.gitbook.com, https://docusaurus.io, and many more

@endiliey
Copy link

A bit random, but we recommend docusaurus 😉

The next major version (still wip) https://v2.docusaurus.io/ is powered by MDX (part of unifiedjs)

@wooorm
Copy link
Member Author

wooorm commented May 29, 2019

Moving this discussion to syntax-tree/ideas#7

@wooorm wooorm added ⛵️ status/released 📚 area/docs This affects documentation 🦋 type/enhancement This is great to have labels Aug 12, 2019
@wooorm wooorm added the 💪 phase/solved Post is done label Apr 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation 💪 phase/solved Post is done 🦋 type/enhancement This is great to have
Development

Successfully merging this pull request may close these issues.

Add enter and exit terms to glossary
3 participants