diff --git a/misskey/readme.md b/misskey/readme.md index e69de29..2044ec7 100644 --- a/misskey/readme.md +++ b/misskey/readme.md @@ -0,0 +1,23 @@ +# Misskey Tweaks +A collection of tweaks that aim to make Misskey less cluttered. +| ![Profile Page](/images/mktweaks_profile.png) | ![Posts](/images/mktweaks_posts.png) | ![Gitea Modern Profile Page](/images/mktweaks_mobile.png) +|---|---|---| + +**Note:** The [Stylus browser extension](https://add0n.com/stylus.html) and [Stylus preprocessor](https://stylus-lang.com/) are two different things. + +### Apply to any instance by [easily managing snippets using Stylus](https://example.com/) +#### Or, add the snippets directly to Misskey: +1. Find the snippet you want to add in the snippets folder of this repo, copy its contents +2. In Misskey, navigate to `Settings > Themes > Install a theme` +3. Paste the contents of the file into the textbox +4. Click Install! + +### Contributing +To make changes, find the tweak you want to edit inside of [`mktweaks.user.css`](theme-gitea-modern.styl), which uses the [Stylus preprocessor](https://stylus-lang.com/). Don't edit anything else outside of the if statements. Please only change one tweak at a time when making a pull request. + +If you want, you can then copy & paste the code into https://stylus-lang.com/try.html, and paste the output into the corresponding `.css` file inside of the tweaks folder. + +[theme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.css +[usertheme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.user.css +[doc-config]: https://docs.gitea.io/en-us/config-cheat-sheet/#ui-ui +[doc-dir]: https://docs.gitea.io/en-us/faq/#where-does-gitea-store-what-file