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 glossary extension #347

Merged
merged 2 commits into from
Dec 9, 2023
Merged

Add glossary extension #347

merged 2 commits into from
Dec 9, 2023

Conversation

andrewpbray
Copy link
Contributor

What does this PR do?

Adds a ref to the glossary extension, a lightweight implementation that copies blocks of content from across many docs and adds them to a different doc as a glossary.

  • glossary - Collect blocks of content across many documents and write them into a glossary.

Requirements for your Awesome item list

  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Has consistent formatting and proper spelling/grammar.
    - The link and description are separated by a dash.
    Example: - [AVA](…) - JavaScript test runner.
    - The description starts with an uppercase character and ends with a period.
    - Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Doesn't use hard-wrapping.
  • Your item(s) fit into an existing sections. (if you think a new section is needed, please explain why your item does not fit into an existing one and what would be the interest of your new section.
  • Add your new item to the bottom of the list in a section.
  • If a duplicate item exists, discuss why the new item should replace it.
  • Check your spelling & grammar.
  • The item must follow this format:
    - [item name](https link) - Description beginning with capital, ending in period.
    
  • Be sure to have read the contributing guidelines.

@andrewpbray andrewpbray requested a review from mcanouil as a code owner August 31, 2023 01:23
@mcanouil
Copy link
Owner

mcanouil commented Sep 3, 2023

Thanks for the PR!
Does it work for any formats? I could not find anything in your README stating the compatibility.

@mcanouil mcanouil self-assigned this Sep 3, 2023
@mcanouil mcanouil added the Type: Suggestion 💡 New suggestion or request label Sep 3, 2023
@andrewpbray
Copy link
Contributor Author

Good question. Let me do some tests. I'll put the results in the README then ping you here.

@andrewpbray
Copy link
Contributor Author

@mcanouil README has been updated with a compatibility section.

Copy link
Owner

@mcanouil mcanouil left a comment

Choose a reason for hiding this comment

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

Thanks, merging now!

@mcanouil mcanouil merged commit 5f6c050 into mcanouil:main Dec 9, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Suggestion 💡 New suggestion or request
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants