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

docs: add extention 'autolink_bare_uris' #1326

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

fronterior
Copy link

📑 Description

Some plugin documentation doesn't work because the links are written in just text instead of link markdown syntax.
Pandoc has an option to automatically convert this, so adding it to the site build process removes the need for contributors to check it.

I checked by running the pages_create.sh script on my local environment and only link text without braces is converted.

ℹ Additional Information

https://pandoc.org/MANUAL.html#extension-autolink_bare_uris

It automatically converts text URLs into anchor tags
Copy link

Review Checklist

Does this PR follow the [Contribution Guidelines](development guidelines)? Following is a partial checklist:

Proper conventional commit scoping:

  • If you are adding a new plugin, the scope would be the name of the category it is being added into. ex. feat(utility): added noice.nvim plugin

  • If you are modifying a pre-existing plugin or pack, the scope would be the name of the plugin folder. ex. fix(noice-nvim): fix LSP handler error

  • Pull request title has the appropriate conventional commit type and scope where the scope is the name of the pre-existing directory in the project as described above

  • README is properly formatted and uses fenced in links with <url> unless they are inside a [title](url)

  • Entry returns a single plugin spec with the new plugin as the only top level spec (not applicable for recipes or packs).

  • Proper usage of opts table rather than setting things up with the config function.

  • Proper usage of specs table for all specs that are not dependencies of a given plugin (not applicable for recipes or packs).

@Uzaaft
Copy link
Member

Uzaaft commented Jan 20, 2025

I vote against this. For a upcoming prototype of the next website for astrocommunity I don’t use pandoc. Leaving the decision up to you @mehalter

cc @AstroNvim/astrocommunity-maintainers

@fronterior
Copy link
Author

However, if accept this PR, we can now add links to unlinked text on the astrocommunity website. I was uncomfortable with this, so I wrote a PR. However, as @Uzaaft says, if a new site is being created soon, I don't think it's necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants