Skip to content

Conversation

@sripwoud
Copy link
Contributor

@sripwoud sripwoud commented Jan 27, 2026

Define a typedoc custom theme that mirror the official docs.exodus.com styles.
This isn't a pixel perfect 1 to 1 mirroring.
It is bit hacky too (lot of !important rules), maybe another frontend dev could find a more elegant implementation but it does the job for now I'd say.
If you have more exodusoss libs documentation you want to host/publish, I could work on making these css rules a real typedoc-exodus packaged theme.

Before After
image image

package.json Outdated
"lint": "eslint .",
"typedoc": "typedoc",
"typedoc:watch": "nodemon --watch src --watch theme --ext ts,js,css --exec 'npm run typedoc'",
"typedoc:serve": "npm run typedoc && npx --yes live-server doc --port=8080 --no-browser",
Copy link
Collaborator

@ChALkeR ChALkeR Jan 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this pulls live-server directly from npm without a lockfile or confirmation. that is unsafe
it should be placed in deps instead

or, better, any package.json changes should be filed as a separate PR from the theme

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it
Still working on it actively, it is not yet ready.
But you should be able to already run it locally to see the style changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i removed the change in the deps that included stuff to watch changes during local dev.
However we must update this script to copy files. Otherwise they wont be applied.
Or do you really want this change in package.json to be separate: meaning merging this first style PR will not applied all styles correctly. It would just look like the default typedoc dark theme.

Image

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copying files is fine, thanks!

@sripwoud sripwoud marked this pull request as ready for review January 27, 2026 13:47
Copy link
Collaborator

@ChALkeR ChALkeR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, thanks!

@ChALkeR ChALkeR merged commit 6db6eff into ExodusOSS:main Jan 27, 2026
30 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants