docs!: use mdbook, add css filters documentation #1445
Conversation
|
I think we still need a better way of surfacing the tips somehow, not sure what the best way is. When new contributors are writing a userstyle their first instinct is most likely not to check tips and tricks lol. |
|
I mean that's what we have now, but I don't like it. Some of these examples/tips/triks are getting super long, and the doument as a whole is getting long as we add more tips. I would love an Mdbook of these and the rest of the docs actually if possible, but that might be something for later. |
|
Alright. I'd rename the |
uncenter
changed the title
Blame it on my sticky C key...
There was a problem hiding this comment.
Re:
Userstyles labeled with the "🚧" emoji are looking for maintainers, and may
not work as intended. Contributions are still welcome and encouraged. If you
would like to become a maintainer, follow the instructions outlined in
"Adding yourself as a maintainer."
Instead of updating the link to be the new github link should we not point to the mdbook?
There was a problem hiding this comment.
I feel like it would be "nicer" to symlink the README here, what do you think?
There was a problem hiding this comment.
I agree sort of; how will we deal with conflicting links? If I link relatively from the symlinked README in the docs directory, it will work on the website, but not on the GitHub readme. And if I link to the website URL from the README, the links aren't really truly accurate on the mdbook page - for example if you were to develop on it and click those links, it would bring you to the deployed version and not the local version because it would be a full URL.
There was a problem hiding this comment.
Also the "edit this page" link would link to the symlink file on GitHub for the main page, which just contains the text "../../README.md"...
There was a problem hiding this comment.
Yeah the only way that it would work is if you replaced the relative GitHub links on the main README with website URLs and avoided clicking those URLs during development. Don't think you can do anything about the "edit this page" link unless you modified the index.hbs ig.
Only reason I mentioned symlinking is that I fear that userstyles.catppuccin.com will become the main "entry" point for people to link to and it feels odd to not have all the main README information on the main page of the mdbook.
There was a problem hiding this comment.
Also while we're talking about links, it's probably a good idea to run https://github.com/Michael-F-Bryan/mdbook-linkcheck since we're linking to quite a few different places right?
There was a problem hiding this comment.
Sure. Right now it will fail a ton since all of the userstyles.catppuccin.com links aren't up yet, maybe we add it later.
There was a problem hiding this comment.
Also the "edit this page" link would link to the symlink file on GitHub for the main page, which just contains the text "../../README.md"...
Can you technically flip the symlink so that the primary page is actually from the mdbook and not from the GitHub README? It feels like this book is going to take the spotlight from the GitHub README lol.
Closes #1089. Thanks @Papweer for the generated palette! Much appreciated.