-
Notifications
You must be signed in to change notification settings - Fork 686
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
Add @category tag #564
Comments
I actually did this as part of our TypeDoc implementation. If you're curious, see jonchardy@c12381b. Alongside these changes, I updated our theme to sort our index page by category. There is some stuff specific to us like the weights for sorting, but you can change that up. Excuse the organization, I usually push things to GitHub in batches. The relevant changes are: |
Pr? @jonchardy |
Created PR #566. Feel free to take a look, discuss, and make any changes you feel will improve it. |
…ong/typedoc#564), and I don't want to use external modules, so I hack around it by telling to typedoc that I have external modules then doing string replace in its output (and then reverting the changes)
Closed by #566 |
Regarding closing this bug: I didn't try the changes yet, but my understanding is that the PR which was pulled, according to its author "won't really do much without some accompanying changes to a theme". So I'm not sure this feature is really complete now. Is changing the theme documented? |
@emmanueltouzery I think you are right. I'll reopen this. PRs are welcome to update the themes. |
I would also love to see multiple
becomes:
|
On a related note: I don't think it's a good idea to reformat the original category name. If need be this can be handled in the theme. typedoc/src/lib/converter/plugins/CategoryPlugin.ts Lines 123 to 128 in 32bf528
|
I opened #1158 to track multiple categories, closing this as there is base functionality for categories already, and the themes have been updated. |
Sometimes globally-scoped things can get pretty cluttered, so I was wondering if you all can add a
@category
tag to sort documented objects into groups.The text was updated successfully, but these errors were encountered: