Repository general update suggestion
konhi opened this issue ยท 10 comments
This repository is popular among Obsidian users. Currently, it has +250 stars and it's often mentioned both in Forum and Discord server.
I think it may be worth to add few things to make it more useful for users and contributors.
License
Currently, there's no license, which may lead to several problems. I suggest adding a license, e.g. MIT.
File structure
/styles
name.css
/media
name-1.gif
name-2.jpg
README.md
README
Usage
How do snippets works and how to use them.
Snippet
- snippet
name
with link toname.css
- description with an example (e.g.
name-1.gif
) - download
Example:
image-cards by author
Makes image smooth.
Before
After
Contributing
How to contribute to this repository.
Let me know what do you think about these changes. I'm happy to help working on it!
I would also be happy to give you guys (@Dmitriy-Shulha and @konhi) push access to awesome-obsidian if you would like to maintain a list of CSS snippets there. I by no means want to take the credit away from you or anything, but it would be nice for the Obsidian community to have a central place were stuff like this can be found - which is what awesome-lists are generally made for.
As @konhi rightfully mentioned here, the CSS section of awesome-obsidian is quite outdated, and I've been meaning to revamp it. I would love to have your help in doing so
If you prefer, I could also just link from awesome-obsidian to here, that's no issue. However, I do think these snippets would reach a wider audience if they are contained within awesome-obsidian and not behind a bunch of links. Excited to hear what you think!
@kmaasrud thanks for reaching out there! I believe that it is indeed a good idea to focus on awesome-obsidian repo, it has crazy amount of stars and references on internet (well done with achieving that!). And I personally love awesome-lists!
Push access is too much for an unacknowledged person like me!
But I would love to work on snippets at awesome-obsidian!
That's awesome, thanks! I love the example you provided here, so I feel that is the way to go
@DutchPete thanks for this useful information! Could you please provide some link to this discussion?