How to get started?
N6REJ opened this issue · comments
I'm confused about how to get it to start creating the doxy.
I'm using the doxy wizard currently.
I'd like it to be a light style so that its close to our existing style at https://bearsampp.com
What do I do?
we're using windows if it matters. The current doxy is at http://api.bearsampp.com
Thanks in advance
Can you clarify what you are confused about? You can find the install instructions here. If you are using the Doxygen GUI you have to select the "Expert" mode in order to be able to adjust the Doxygen options.
Got all figured out, except I can't get the lite/dark switcher to show up.
@jothepro I'm still having issues.
- I can't get the dark mode toggle to show.
- the sidebar is too narrow as it truncates the version number.
- I think there should probably be some information here like you have here https://jothepro.github.io/doxygen-awesome-css/index.html but I don't see how to do that.
in this file https://jothepro.github.io/doxygen-awesome-css/md_docs_2customization.html you have
html {
/* override light-mode variables here */
}
but I don't see where that is supposed to go.
My info:
builder: doxygen wizard 1.11.0
api site: http://api.bearsampp.com
doxyfile : Doxyfile.txt
html-header-override: header.html.txt
css overide:
#projectname {font-size:0}
#projectnumber {font-size:initial}
includes: all doxygen-awesome files.
I can't get the dark mode toggle to show.
From looking at the link that you provided, it seems to me like you did not include the required JS file for the dark mode toggle in the HTML header. You can find instructions on how to do that here
the sidebar is too narrow as it truncates the version number.
Yes, that's an unfortunate known problem. You can adjust the sidebar by overriding the --side-nav-fixed-width CSS variable (more details).
I think there should probably be some information here like you have here
I am not sure what you mean, but I am assuming you would like to add content to the landing page (index.html) of your documentation? I've achieved this by having the USE_MDFILE_AS_MAINPAGE Doxygen point to the README.md file in this repository (see here)
but I don't see where that is supposed to go.
That's a snippet of CSS, you can put it in your custom CSS file, in your case no-project-name.css. You can see an example for a custom theme here.
I hope this helped! :)
that fixes everything but the readme. I've tried
https://github.com/Bearsampp/Bearsampp/blob/main/README.md
and
USE_MDFILE_AS_MAINPAGE = ../../Bearsampp-development/sandbox/README.md
neither work