Skip to content

[WIP] Ddoc: in-site (Ddox-like) search (chmgen version) #2328

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

Closed
wants to merge 1 commit into from

Conversation

wilzbach
Copy link
Member

@wilzbach wilzbach commented Apr 2, 2018

This is an initial experiment with using the symbols from chmgen for an in-site search.

Cons:

  • JSON file is rather large (1.7M, 171K gzipped) - though the JSON file can be loaded lazily, s.t. this shouldn't have an impact
  • no information about the symbol (class vs. struct, enum?, member?, field?)

See also: #2314

Todo:

  • filter for duplicates?
  • sort the results in a meaningful way
  • generate a shortname for long names
  • expand the name, e.g. std_regex#.splitter should be displayed as such not a just splitter

Example:

Chmgen:

image

Ddox's symbols:

image

@dlang-bot
Copy link
Contributor

Thanks for your pull request, @wilzbach!

Bugzilla references

Your PR doesn't reference any Bugzilla issue.

If your PR contains non-trivial changes, please reference a Bugzilla issue or create a manual changelog.

@wilzbach
Copy link
Member Author

wilzbach commented Apr 3, 2018

Closing in favor of #2314 (using DDox's symbols)

@wilzbach wilzbach closed this Apr 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants