SoftwareBrothers / better-docs

Code Issues 69 Pull requests 18 Actions Projects 1 Wiki Security Insights

New issue Jump to bottom

better-docs theme for the primary font and a few brand colors
#74
Closed headwinds opened this issue
on Apr 27, 2020
· 2 comments

headwinds
commented
on Apr 27, 2020

I like the layout and appreciate all the thought that was gone into the design of this project.

I see that its possible to customize the look and feel in the Readme but it doesn't mention passing in a theme config. Is a custom logo and
then black & white my only option branding?

Similar to Material UI, have you considered passing a simple theme config to change primary fonts and colors?

👀
1

headwinds
commented
on Apr 27, 2020
•
edited
Author

I'll provide a little more detail...

I've have a toy design system project where I'm trying to learn how to auto generate the docs. If I can get working for my toy project, then
I'll attempt to convince my co-workers to adopt it in our larger shared component library.

So I was able to add my own branding in this demo...

demo

...and here's my hack

After some research into jsdocs, I learned about the layout.tmpl file and I was able to go into the node_modules directory and find your
version and then add my custom styles so that they show up on every page. Now, when I run yarn docs I get my desired styling on every
page.

So this could close this issue but just curious if there's a better approach that you'd recommend or you might consider adding this as a
README documentation as a way to add your own branding potentially.

Your @category tag is brilliant by the way! It really works well with an atomic design approach. I couldn't get the @component tag to work
though but I realize its still in beta and am fine with just printing the source for now- that did look pretty compelling though similar to
react-live.

👍
1

wojtek-krysiak
commented
on Apr 30, 2020 Contributor

thanks :) glad you fixed that. I've just merged a community PR with the css option

betterDocs: {"css": "style.css",}

 so you can override everything there and there is no need to do this by changing the code of the package

wojtek-krysiak
closed this
on Apr 30, 2020

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Linked pull requests

Successfully merging a pull request may close this issue.

None yet

2 participants