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 github pages #1273

Merged
merged 2 commits into from
Nov 20, 2024
Merged

docs: Add github pages #1273

merged 2 commits into from
Nov 20, 2024

Conversation

Kamilcuk
Copy link
Contributor

📑 Description

Adds releasing a GitHub pages site composed out of all README.md of all plugins.

The page looks like the following: https://kamilcuk.github.io/astrocommunity/

ℹ Additional Information

Kindly give me any feedback and suggestions.

Fixes #1272

Thank you.

Copy link

github-actions bot commented Nov 17, 2024

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).

@ALameLlama ALameLlama changed the title add github pages build(docs): Add github pages Nov 17, 2024
@ALameLlama
Copy link
Member

I've updated the PR title to be https://www.conventionalcommits.org/en/v1.0.0/. The preview looks great IMO, I'll have a read over the code later tonight

@Uzaaft Uzaaft changed the title build(docs): Add github pages docs: Add github pages Nov 18, 2024
@Uzaaft
Copy link
Member

Uzaaft commented Nov 18, 2024

Sick idea! I like this

@mehalter mehalter merged commit f5f3442 into AstroNvim:main Nov 20, 2024
15 of 16 checks passed
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.

Feature request: github pages with all the plugins on one page to easy search them
4 participants