-
Notifications
You must be signed in to change notification settings - Fork 149
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
[WIP] Big Docs Update™ #479
Conversation
TODO: go back through everything and see if I've missed something
@dtinth It seems like overriding the Docusaurus CSS is quite simple to do. Will look more into it tomorrow, it's way past midnight here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great! Thanks so much for your effort.
By the way, should we make This allows the deps for both the main project and website to be installed in one go. Additionally, it will pave the way for us to centralize the build and publishing system for Bemuse-related packages (for example, the |
@dtinth Yeah, sure! |
Also, another thing that I forgot to add with the Docusaurus conversion is that MathJax parsing no longer works. Will have to convert them to images or inlined in |
That’s fine, we can add MathJax script (or KaTeX) to the page as well. |
@dtinth Alright, I've added the MathJax scripts on the Docusaurus config. It now works normally again. |
@dtinth Ready for initial design feedback. After that, I'll do some quick cleanup, then it's up to you to fill up/update the contents and replace the placeholder images. |
The project page lives at /project/
I have set up Yarn workspace and set up the build process to also generate the documentation site. For this PR, the result can be previewed at: https://deploy-preview-479--bemuse.netlify.com/project/ When deployed to production, the URL will be https://bemuse.ninja/project/ The pathname The design looks great! While I preview, I think the logo is the wrong variant? (There is a variant for use on Dark background and Light background.) Also, I prefer the navbar color to be a bit more saturated, e.g. Thanks! |
I added a list of colors here: https://deploy-preview-479--bemuse.netlify.com/project/docs/developers-colors.html |
@dtinth Yeah, we can definitely merge some content from the wiki to the new docs site! After the merging, we can simply disable the wiki. |
Alright, I've attempted merging contents for the music server guide from the wiki to the docs page. Anyways, once this is finished, I might create a PR on the Docusaurus repo to have this project included on their showcase. :D |
…n main project for custom components)
I think this is ready to merge. Thanks for your help pushing the new documentation website! ^_^ |
Closes #473.
TODO
.rst
to.md
(Some Sphinx-related components are converted to raw HTML).Convert any old codedoc-based documentation blocks into valid JSDoc.