Skip to content

Add opensearch.xml to enable search of std using omnibox #3594

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 2 commits into from

Conversation

mbarkhau
Copy link

@mbarkhau mbarkhau commented Nov 4, 2019

No description provided.

Copy link
Contributor

@daurnimator daurnimator left a comment

Choose a reason for hiding this comment

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

Cool idea!

@@ -4,6 +4,8 @@
<meta charset="utf-8">
<title>Documentation - Zig</title>
<link rel="icon" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAAgklEQVR4AWMYWuD7EllJIM4G4g4g5oIJ/odhOJ8wToOxSTXgNxDHoeiBMfA4+wGShjyYOCkG/IGqWQziEzYAoUAeiF9D5U+DxEg14DRU7jWIT5IBIOdCxf+A+CQZAAoopEB7QJwBCBwHiip8UYmRdrAlDpIMgApwQZNnNii5Dq0MBgCxxycBnwEd+wAAAABJRU5ErkJggg==">
<link rel="search" href="opensearch.xml" type="application/opensearchdescription+xml" title="std - Zig Search">
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "Zig Library Documentation Search"?

Copy link
Author

Choose a reason for hiding this comment

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

Sure

@mbarkhau
Copy link
Author

mbarkhau commented Nov 6, 2019

Anny way to retrigger the build?

@andrewrk
Copy link
Member

andrewrk commented Nov 6, 2019

@mbarkhau don't worry about the CI, this change is harmless.

I'll merge this soon - I just want to hook it up so that it's only in the std lib docs, and not in everybody's auto generated docs.

@mbarkhau
Copy link
Author

mbarkhau commented Nov 7, 2019

@andrewrk Good point.

@andrewrk
Copy link
Member

Thanks for the idea! This is live now.

ziglang/www.ziglang.org@3cbeacb

I tried the feature out with Firefox, and it doesn't seem to work very well, it's a lot of button presses to activate, and then it puts extra unwanted characters into the search box. 🤷‍♂️

Auto generated docs is still Work-In-Progress. Updating the std lib documentation is still a manual process. #3402

@andrewrk andrewrk closed this Dec 18, 2019
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.

3 participants