Bluemoondragon07 / chime-theme

A lightweight theme for Obsidian designed to be simple yet highly customizable.
MIT License
58 stars 4 forks source link

Improve readme #18

Closed FireIsGood closed 8 months ago

FireIsGood commented 8 months ago

The readme had a few markdown errors (checked via the markdownlint plugin for Visual Studio Code) for spacing and header semantics.

This pull request addresses:

The change to headers is debatable, so I have included it as a separate commit after all the other more basic lints.

While markdown dictates that there should only be a single h1 element, it is mostly helpful for semantic styling like with Obsidian themes. In this case, though, the readme will be read on GitHub where it is rendered with a set style. It could be argued that the header size of an h1 element looks better than if they were changed to be more semantically correct.

I leave the decision of whether to accept the header level commit to the repo's maintainer.

Bluemoondragon07 commented 8 months ago

Wow, thank you for touching up the readme! I never considered running my readmes through a linter.

By the way, I'm a big fan of your Everforest Enchanted theme! 💖🌲