├── .github
└── workflows
│ └── docs.yml
├── .gitignore
├── .gitmodules
├── LICENSE-APACHE
├── LICENSE-MIT
├── Makefile
├── README.md
├── docs
├── config.toml
├── content
│ ├── _index.md
│ ├── changelog.md
│ ├── faq.md
│ ├── privacy.md
│ └── testimonial.md
├── sass
│ └── index.scss
├── static
│ ├── banner.png
│ ├── chrome.svg
│ ├── commands.png
│ ├── cpp-search-extension.gif
│ ├── edge.svg
│ ├── firefox.svg
│ ├── logo.png
│ └── offline-mode.gif
└── templates
│ ├── _variables.html
│ └── index.html
├── extension
├── command
│ ├── header.js
│ ├── help.js
│ └── posix.js
├── index
│ ├── headers.js
│ ├── posix.js
│ └── std.js
├── logo.png
├── main.js
├── popup
│ ├── index.css
│ ├── index.html
│ └── index.js
├── search
│ └── std.js
├── service-worker.js
└── settings.js
├── manifest.jsonnet
├── tools
├── Cargo.toml
├── headers.js
├── posix
│ ├── Cargo.toml
│ └── src
│ │ └── main.rs
└── std
│ ├── Cargo.toml
│ ├── search-c
│ ├── search-cpp
│ └── src
│ └── main.rs
└── vercel.json
/.github/workflows/docs.yml:
--------------------------------------------------------------------------------
1 | name: docs
2 |
3 | on:
4 | workflow_dispatch:
5 | repository_dispatch:
6 | types: deploy-docs
7 |
8 | jobs:
9 | build:
10 | name: Deploy to now branch
11 | runs-on: ubuntu-latest
12 | steps:
13 | - uses: actions/checkout@v2
14 | with:
15 | ref: 'master'
16 | submodules: 'recursive'
17 | - run: |
18 | git fetch --no-tags --prune --depth=1 origin +refs/heads/*:refs/remotes/origin/*
19 | - name: Deloy docs
20 | run: |
21 | source ./core/deploy-docs.sh && build && deploy
22 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | .DS_Store
3 | *.crx
4 | *.pem
5 | web-ext-artifacts
6 | node_modules
7 | target
8 | docs/public
9 | *.db
10 | manifest.json
11 | extension/core
12 |
13 | tools/target
14 | tools/Cargo.lock
--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "core"]
2 | path = core
3 | url = git@github.com:huhu/search-extension-core.git
4 | [submodule "docs/themes/juice"]
5 | path = docs/themes/juice
6 | url = https://github.com/huhu/juice
7 |
--------------------------------------------------------------------------------
/LICENSE-APACHE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2020 C/C++ Search Extension teams
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/LICENSE-MIT:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2020 C/C++ Search Extension
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | include core/extension.mk
2 |
3 | .PHONY: chrome
4 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # C/C++ Search Extension
2 |
3 |
4 |
5 | ### The ultimate search extension for C/C++.
6 |
7 | 
8 | 
9 | 
10 | [](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-MIT)
11 | [](https://github.com/huhu/cpp-search-extension/blob/master/LICENSE)
12 | [](https://discord.gg/xucZNVd)
13 |
14 | [https://cpp.extension.sh/](https://cpp.extension.sh/)
15 |
16 | ## Installation
17 |
18 | - [Chrome Web Store](https://chrome.google.com/webstore/detail/cc++-search-extension/ifpcmhciihicaljnhgobnhoehoabidhd)
19 |
20 | - [Firefox](https://addons.mozilla.org/en-US/firefox/addon/c-c-search-extension/)
21 |
22 | - [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/ffajabficigcddnckikojejmkammkmpe)
23 |
24 |
25 | ## Features
26 |
27 | - Search standard library docs
28 | - Offline mode supported
29 | - Builtin commands (`:header`, `:posix` and `:history` etc)
30 |
31 | ## How to use it
32 |
33 | Input keyword **cc** in the address bar, press `Space` to activate the search bar. Then enter any word
34 | you want to search, the extension will response the related search results instantly.
35 |
36 | ## Contribution
37 |
38 | [jsonnet](https://jsonnet.org/) is required before getting started. To install `jsonnet`, please check `jsonnet`'s [README](https://github.com/google/jsonnet#packages). For Linux users, the `snap` is a good choice to [install jsonnet](https://snapcraft.io/install/jsonnet/ubuntu).
39 |
40 | ```bash
41 | $ git clone --recursive https://github.com/huhu/cpp-search-extension
42 | Cloning into 'cpp-search-extension'...
43 |
44 | $ cd cpp-search-extension
45 |
46 | $ make chrome # For Chrome version
47 |
48 | $ make firefox # For Firefox version
49 |
50 | $ make edge # For Edge version
51 | ```
52 |
53 | ## Get involved
54 |
55 | - You can contact us on Discord Channel: https://discord.gg/xucZNVd
56 |
--------------------------------------------------------------------------------
/docs/config.toml:
--------------------------------------------------------------------------------
1 | # The URL the site will be built for
2 | base_url = "/"
3 |
4 | # Whether to automatically compile all Sass files in the sass directory
5 | compile_sass = true
6 |
7 | # Whether to do syntax highlighting
8 | highlight_theme = "inspired-github"
9 | # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
10 | highlight_code = true
11 |
12 | # Whether to build a search index to be used later on by a JavaScript library
13 | build_search_index = false
14 | theme = "juice"
15 |
16 | [extra]
17 | # Put all your custom variables here
18 | juice_logo_name = "C/C++ Search Extension"
19 | juice_logo_path = "logo.png"
20 | juice_extra_menu = [
21 | { title = "Github", link = "https://github.com/huhu/cpp-search-extension"}
22 | ]
23 | repository_url = "https://github.com/huhu/cpp-search-extension"
24 | meta_title = "C/C++ Search Extension: The ultimate search extension for C/C++"
25 | meta_description = "Input keyword cc then press Space in the address bar to get started. Just that easy!"
--------------------------------------------------------------------------------
/docs/content/_index.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "C/C++ Search Extension"
3 | sort_by = "weight"
4 | +++
5 |
6 | # Search std docs
7 |
8 | We built an offline search index for C/C++ std library based on [cppreference.com](https://en.cppreference.com/w/).
9 | Input any keyword in the address bar, you'll get the result instantly. It's blaze-fast!
10 |
11 | 
12 |
13 | # Offline mode
14 |
15 | You can download the offline archive from [Cppreference archiven page](https://en.cppreference.com/w/Cppreference:Archives).
16 | To enable the offline mode, you should check the checkbox and input the offline docs path on the popup page.
17 | However, please check the [Caveats](/faq/#caveats) if you are a Firefox user.
18 |
19 | 
20 |
21 | # Command systems
22 |
23 | The command system brings a handy set of useful and convenient commands to you. Each command starts with a **:** (colon), followed by the name, and function differently in individual. Those commands including but not limited to:
24 |
25 | - `:help` - Show the help messages.
26 | - `:header` - Show all C++ header libraries.
27 | - `:posix` - Show all POSIX [system interfaces](https://pubs.opengroup.org/onlinepubs/9799919799/functions/contents.html).
28 | - `:history` - Show your local search history
29 |
30 | 
31 |
32 | # Miscellaneous
33 |
34 | ## Multi-locale language search
35 |
36 | You can configure you prefer locale language for cppreference docs search in the popup page.
37 |
38 | ## Page down/up easily
39 |
40 | You can press `space` after the keyword, then increase or decrease the number of **-** (hyphen) to page down or page up.
41 |
--------------------------------------------------------------------------------
/docs/content/changelog.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Changelog"
3 | description = "Changelog"
4 | weight = 3
5 | +++
6 |
7 |
8 | # v0.4 - 2023-07-29
9 |
10 | - Update to last cppreference.com docs
11 | - Add options page to configure offline docs path
12 | - Migrate to latest jsonnet
13 | - Add index generating tools
14 |
15 | # v0.3 - 2022-06-02
16 |
17 | - Migrate from `localStorage` to `chrome.storage` API. The new `storage` permission is required.
18 | - Remove the `tabs` permission requirement.
19 | - Remove offline doc path validation. Fixes {{ issue(id=8) }}.
20 |
21 | # v0.2 - 2021-01-31
22 |
23 | - Support multi-locale language cppreference docs search
24 | - New command:
25 | - `:posix` - Show all POSIX [system interfaces](https://pubs.opengroup.org/onlinepubs/9799919799/functions/contents.html)
26 | - Improve user experience of offline doc path configuration, thanks to the PR ([#3](https://github.com/huhu/cpp-search-extension/pull/3)) from [@knewbie](https://github.com/knewbie).
27 |
28 | # v0.1 - 2020-09-30
29 |
30 | First release version! 🎉🥳🥳
31 |
32 | - Search C/C++ standard library docs
33 | - Offline mode supported
34 | - Command systems:
35 | - `:help` command to show all help messages
36 | - `:header` command to show all C++ header libraries
37 | - `:history` command to show your local search history
38 |
39 |
40 |
--------------------------------------------------------------------------------
/docs/content/faq.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "FAQ"
3 | description = "Frequently asked questions"
4 | weight = 2
5 | +++
6 |
7 | # Platform
8 |
9 | ### Any plans to support Safari?
10 |
11 | Unfortunately, no. According to MDN's web extension [compatibility chart](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs#omnibox):
12 | Safari doesn't support omnibox API, which is essential to this extension.
13 |
14 | # Caveats
15 |
16 | ### Why local `file:` doc not work properly on Firefox?
17 |
18 | For security reasons, in Firefox, `file:` URLs is an unprivileged URL, accessing to those unprivileged URLs are prohibited.
19 | See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/create) for more detail.
20 |
21 | ### Any workaround to support offline mode on Firefox?
22 |
23 | Sure. A good choice is use http server! For example using python **http.server** module:
24 |
25 | ```sh
26 | $ cd ~/Downloads/html-book-20200913/reference
27 | $ python -m http.server
28 | Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
29 | ```
30 |
31 | Then set `http://0.0.0.0:8000/en` as your local doc path.
32 |
--------------------------------------------------------------------------------
/docs/content/privacy.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Privacy"
3 | description = "Privacy Policy"
4 | weight = 3
5 | +++
6 |
7 |
8 | -- Last updated: 2020-04-20
9 |
10 | [Huhu.io](https://huhu.io), ("we",or "us") operates the **C/C++ Search Extension** (including Chrome, Firefox and Microsoft Edge versions) and the website [https://cpp.extension.sh](/) (collectively, the “Service” or “Products”).
11 | We believe that your privacy is a fundamental right. This page informs you of our policies and practices regarding the collection, use and disclosure of information which personally identifies you ("Personal Information") when you use our Service.
12 |
13 | # Information collection
14 |
15 | No information do we collect, including and not limited to:
16 |
17 | - Your search history
18 | - Your search preferences
19 |
20 | # Updates to this Privacy Policy
21 |
22 | We reserve the right to update or change our Privacy Policy at any time and you should check this Privacy Policy periodically. Your continued use of the Service after we post any modifications to the Privacy Policy on this page will constitute your acknowledgment of the modifications and your consent to abide and be bound by the modified Privacy Policy.
23 |
24 | The "Last updated" legend at the top of this Privacy Policy indicates when this Privacy Policy was last revised. Any changes are effective when we post the revised Privacy Policy on the Services.
25 |
26 | # Contact us
27 |
28 | If You have any questions about this Privacy Policy, please contact us at [legal@huhu.io](mailto:legal@huhu.io).
--------------------------------------------------------------------------------
/docs/content/testimonial.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Testimonial"
3 | description = "Testimonials"
4 | weight = 1
5 | +++
6 |
7 | ### From *Khalil Estell*
8 |
9 | > Use this extension literally everyday and it makes looking up details in C++ so much faster. This is a great too for C++ power users.
10 |
11 | ### From *Luna Lucadou*
12 |
13 | > This extension is perfect! Chrome never seems to suggest cpp docs from my history (probably because of std:: being mistaken for a protocol, and "thread", "string", etc. being too generic), so this saves those extra clicks to get to them.
14 |
15 | ### From *u/anon_502*
16 |
17 | > Awesome! Perhaps I can finally remove Zeal from my laptop.
18 |
19 | ### From *u/witcher_rat*
20 |
21 | > I wanted to thank you - I've been using it on Firefox ever since
22 | > you posted about the first release. I use it almost every day, so thank you!
23 |
24 | ### From *u/Adequat91*
25 |
26 | > Thanks for your time!... it will save time for many of us :)
27 |
28 | ### From *Darius-Florentin Neațu*
29 |
30 | > Awesome! You can directly open a page for a feature/entity from docs.
31 |
32 |
--------------------------------------------------------------------------------
/docs/sass/index.scss:
--------------------------------------------------------------------------------
1 | .content img {
2 | width: 75%;
3 | height: auto;
4 | }
5 |
6 | .demonstration-gif {
7 | max-width: 55%;
8 | padding: 20px;
9 | }
10 |
11 | .btn-download {
12 | font-family: "Fira Sans", sans-serif;
13 | color: black;
14 | background-color: #FDFDFD;
15 | border-radius: 12px;
16 | margin: 15px;
17 | padding: 10px 0 10px 20px;
18 | font-size: 20px;
19 | text-align: center;
20 | background-repeat: no-repeat;
21 | background-size: 24px 24px;
22 | background-position: 20px;
23 | width: 240px;
24 | }
25 |
26 | .chrome {
27 | background-image: url("chrome.svg");
28 | }
29 |
30 | .firefox {
31 | background-image: url("firefox.svg");
32 | }
33 |
34 | .edg {
35 | background-image: url("edge.svg");
36 | }
37 |
38 | .hide {
39 | display: none;
40 | }
41 |
42 | .sidebar {
43 | width: 215px;
44 | }
45 |
46 | @media screen and (max-width: 768px) {
47 | .logo {
48 | font-size: 16px;
49 | margin: 10px;
50 |
51 | img {
52 | width: 25px;
53 | margin: 0 10px 0 0;
54 | }
55 | }
56 |
57 | main {
58 | padding: 30px;
59 | display: flex;
60 | flex-direction: column;
61 | }
62 |
63 | .sidebar {
64 | width: 215px;
65 | margin: 2rem auto 0;
66 | }
67 |
68 | .explore-more, .demonstration-gif {
69 | display: none;
70 | }
71 |
72 | .content img {
73 | width: 100%;
74 | height: auto;
75 | }
76 | }
--------------------------------------------------------------------------------
/docs/static/banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/banner.png
--------------------------------------------------------------------------------
/docs/static/chrome.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/commands.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/commands.png
--------------------------------------------------------------------------------
/docs/static/cpp-search-extension.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/cpp-search-extension.gif
--------------------------------------------------------------------------------
/docs/static/edge.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/firefox.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/logo.png
--------------------------------------------------------------------------------
/docs/static/offline-mode.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/offline-mode.gif
--------------------------------------------------------------------------------
/docs/templates/_variables.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends "juice/templates/index.html" %}
2 | {% block head %}
3 |
5 |
7 |
9 |
10 |
11 |
12 |
13 |
15 |
17 |
18 |
19 |
20 |
21 |
22 |
24 |
26 |
27 |
28 |
29 | {% endblock head %}
30 | {% block hero %}
31 |
32 |
33 | The ultimate search extension for C/C++
34 |
35 |
36 | Input keyword cc then press
37 | Space in the address bar
38 | to get started. Just that easy!
39 |
4 |
5 | ### The ultimate search extension for C/C++.
6 |
7 | 
8 | 
9 | 
10 | [](https://github.com/huhu/rust-search-extension/blob/master/LICENSE-MIT)
11 | [](https://github.com/huhu/cpp-search-extension/blob/master/LICENSE)
12 | [](https://discord.gg/xucZNVd)
13 |
14 | [https://cpp.extension.sh/](https://cpp.extension.sh/)
15 |
16 | ## Installation
17 |
18 | - [Chrome Web Store](https://chrome.google.com/webstore/detail/cc++-search-extension/ifpcmhciihicaljnhgobnhoehoabidhd)
19 |
20 | - [Firefox](https://addons.mozilla.org/en-US/firefox/addon/c-c-search-extension/)
21 |
22 | - [Microsoft Edge](https://microsoftedge.microsoft.com/addons/detail/ffajabficigcddnckikojejmkammkmpe)
23 |
24 |
25 | ## Features
26 |
27 | - Search standard library docs
28 | - Offline mode supported
29 | - Builtin commands (`:header`, `:posix` and `:history` etc)
30 |
31 | ## How to use it
32 |
33 | Input keyword **cc** in the address bar, press `Space` to activate the search bar. Then enter any word
34 | you want to search, the extension will response the related search results instantly.
35 |
36 | ## Contribution
37 |
38 | [jsonnet](https://jsonnet.org/) is required before getting started. To install `jsonnet`, please check `jsonnet`'s [README](https://github.com/google/jsonnet#packages). For Linux users, the `snap` is a good choice to [install jsonnet](https://snapcraft.io/install/jsonnet/ubuntu).
39 |
40 | ```bash
41 | $ git clone --recursive https://github.com/huhu/cpp-search-extension
42 | Cloning into 'cpp-search-extension'...
43 |
44 | $ cd cpp-search-extension
45 |
46 | $ make chrome # For Chrome version
47 |
48 | $ make firefox # For Firefox version
49 |
50 | $ make edge # For Edge version
51 | ```
52 |
53 | ## Get involved
54 |
55 | - You can contact us on Discord Channel: https://discord.gg/xucZNVd
56 |
--------------------------------------------------------------------------------
/docs/config.toml:
--------------------------------------------------------------------------------
1 | # The URL the site will be built for
2 | base_url = "/"
3 |
4 | # Whether to automatically compile all Sass files in the sass directory
5 | compile_sass = true
6 |
7 | # Whether to do syntax highlighting
8 | highlight_theme = "inspired-github"
9 | # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
10 | highlight_code = true
11 |
12 | # Whether to build a search index to be used later on by a JavaScript library
13 | build_search_index = false
14 | theme = "juice"
15 |
16 | [extra]
17 | # Put all your custom variables here
18 | juice_logo_name = "C/C++ Search Extension"
19 | juice_logo_path = "logo.png"
20 | juice_extra_menu = [
21 | { title = "Github", link = "https://github.com/huhu/cpp-search-extension"}
22 | ]
23 | repository_url = "https://github.com/huhu/cpp-search-extension"
24 | meta_title = "C/C++ Search Extension: The ultimate search extension for C/C++"
25 | meta_description = "Input keyword cc then press Space in the address bar to get started. Just that easy!"
--------------------------------------------------------------------------------
/docs/content/_index.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "C/C++ Search Extension"
3 | sort_by = "weight"
4 | +++
5 |
6 | # Search std docs
7 |
8 | We built an offline search index for C/C++ std library based on [cppreference.com](https://en.cppreference.com/w/).
9 | Input any keyword in the address bar, you'll get the result instantly. It's blaze-fast!
10 |
11 | 
12 |
13 | # Offline mode
14 |
15 | You can download the offline archive from [Cppreference archiven page](https://en.cppreference.com/w/Cppreference:Archives).
16 | To enable the offline mode, you should check the checkbox and input the offline docs path on the popup page.
17 | However, please check the [Caveats](/faq/#caveats) if you are a Firefox user.
18 |
19 | 
20 |
21 | # Command systems
22 |
23 | The command system brings a handy set of useful and convenient commands to you. Each command starts with a **:** (colon), followed by the name, and function differently in individual. Those commands including but not limited to:
24 |
25 | - `:help` - Show the help messages.
26 | - `:header` - Show all C++ header libraries.
27 | - `:posix` - Show all POSIX [system interfaces](https://pubs.opengroup.org/onlinepubs/9799919799/functions/contents.html).
28 | - `:history` - Show your local search history
29 |
30 | 
31 |
32 | # Miscellaneous
33 |
34 | ## Multi-locale language search
35 |
36 | You can configure you prefer locale language for cppreference docs search in the popup page.
37 |
38 | ## Page down/up easily
39 |
40 | You can press `space` after the keyword, then increase or decrease the number of **-** (hyphen) to page down or page up.
41 |
--------------------------------------------------------------------------------
/docs/content/changelog.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Changelog"
3 | description = "Changelog"
4 | weight = 3
5 | +++
6 |
7 |
8 | # v0.4 - 2023-07-29
9 |
10 | - Update to last cppreference.com docs
11 | - Add options page to configure offline docs path
12 | - Migrate to latest jsonnet
13 | - Add index generating tools
14 |
15 | # v0.3 - 2022-06-02
16 |
17 | - Migrate from `localStorage` to `chrome.storage` API. The new `storage` permission is required.
18 | - Remove the `tabs` permission requirement.
19 | - Remove offline doc path validation. Fixes {{ issue(id=8) }}.
20 |
21 | # v0.2 - 2021-01-31
22 |
23 | - Support multi-locale language cppreference docs search
24 | - New command:
25 | - `:posix` - Show all POSIX [system interfaces](https://pubs.opengroup.org/onlinepubs/9799919799/functions/contents.html)
26 | - Improve user experience of offline doc path configuration, thanks to the PR ([#3](https://github.com/huhu/cpp-search-extension/pull/3)) from [@knewbie](https://github.com/knewbie).
27 |
28 | # v0.1 - 2020-09-30
29 |
30 | First release version! 🎉🥳🥳
31 |
32 | - Search C/C++ standard library docs
33 | - Offline mode supported
34 | - Command systems:
35 | - `:help` command to show all help messages
36 | - `:header` command to show all C++ header libraries
37 | - `:history` command to show your local search history
38 |
39 |
40 |
--------------------------------------------------------------------------------
/docs/content/faq.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "FAQ"
3 | description = "Frequently asked questions"
4 | weight = 2
5 | +++
6 |
7 | # Platform
8 |
9 | ### Any plans to support Safari?
10 |
11 | Unfortunately, no. According to MDN's web extension [compatibility chart](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Browser_support_for_JavaScript_APIs#omnibox):
12 | Safari doesn't support omnibox API, which is essential to this extension.
13 |
14 | # Caveats
15 |
16 | ### Why local `file:` doc not work properly on Firefox?
17 |
18 | For security reasons, in Firefox, `file:` URLs is an unprivileged URL, accessing to those unprivileged URLs are prohibited.
19 | See the [MDN documentation](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/create) for more detail.
20 |
21 | ### Any workaround to support offline mode on Firefox?
22 |
23 | Sure. A good choice is use http server! For example using python **http.server** module:
24 |
25 | ```sh
26 | $ cd ~/Downloads/html-book-20200913/reference
27 | $ python -m http.server
28 | Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) ...
29 | ```
30 |
31 | Then set `http://0.0.0.0:8000/en` as your local doc path.
32 |
--------------------------------------------------------------------------------
/docs/content/privacy.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Privacy"
3 | description = "Privacy Policy"
4 | weight = 3
5 | +++
6 |
7 |
8 | -- Last updated: 2020-04-20
9 |
10 | [Huhu.io](https://huhu.io), ("we",or "us") operates the **C/C++ Search Extension** (including Chrome, Firefox and Microsoft Edge versions) and the website [https://cpp.extension.sh](/) (collectively, the “Service” or “Products”).
11 | We believe that your privacy is a fundamental right. This page informs you of our policies and practices regarding the collection, use and disclosure of information which personally identifies you ("Personal Information") when you use our Service.
12 |
13 | # Information collection
14 |
15 | No information do we collect, including and not limited to:
16 |
17 | - Your search history
18 | - Your search preferences
19 |
20 | # Updates to this Privacy Policy
21 |
22 | We reserve the right to update or change our Privacy Policy at any time and you should check this Privacy Policy periodically. Your continued use of the Service after we post any modifications to the Privacy Policy on this page will constitute your acknowledgment of the modifications and your consent to abide and be bound by the modified Privacy Policy.
23 |
24 | The "Last updated" legend at the top of this Privacy Policy indicates when this Privacy Policy was last revised. Any changes are effective when we post the revised Privacy Policy on the Services.
25 |
26 | # Contact us
27 |
28 | If You have any questions about this Privacy Policy, please contact us at [legal@huhu.io](mailto:legal@huhu.io).
--------------------------------------------------------------------------------
/docs/content/testimonial.md:
--------------------------------------------------------------------------------
1 | +++
2 | title = "Testimonial"
3 | description = "Testimonials"
4 | weight = 1
5 | +++
6 |
7 | ### From *Khalil Estell*
8 |
9 | > Use this extension literally everyday and it makes looking up details in C++ so much faster. This is a great too for C++ power users.
10 |
11 | ### From *Luna Lucadou*
12 |
13 | > This extension is perfect! Chrome never seems to suggest cpp docs from my history (probably because of std:: being mistaken for a protocol, and "thread", "string", etc. being too generic), so this saves those extra clicks to get to them.
14 |
15 | ### From *u/anon_502*
16 |
17 | > Awesome! Perhaps I can finally remove Zeal from my laptop.
18 |
19 | ### From *u/witcher_rat*
20 |
21 | > I wanted to thank you - I've been using it on Firefox ever since
22 | > you posted about the first release. I use it almost every day, so thank you!
23 |
24 | ### From *u/Adequat91*
25 |
26 | > Thanks for your time!... it will save time for many of us :)
27 |
28 | ### From *Darius-Florentin Neațu*
29 |
30 | > Awesome! You can directly open a page for a feature/entity from docs.
31 |
32 |
--------------------------------------------------------------------------------
/docs/sass/index.scss:
--------------------------------------------------------------------------------
1 | .content img {
2 | width: 75%;
3 | height: auto;
4 | }
5 |
6 | .demonstration-gif {
7 | max-width: 55%;
8 | padding: 20px;
9 | }
10 |
11 | .btn-download {
12 | font-family: "Fira Sans", sans-serif;
13 | color: black;
14 | background-color: #FDFDFD;
15 | border-radius: 12px;
16 | margin: 15px;
17 | padding: 10px 0 10px 20px;
18 | font-size: 20px;
19 | text-align: center;
20 | background-repeat: no-repeat;
21 | background-size: 24px 24px;
22 | background-position: 20px;
23 | width: 240px;
24 | }
25 |
26 | .chrome {
27 | background-image: url("chrome.svg");
28 | }
29 |
30 | .firefox {
31 | background-image: url("firefox.svg");
32 | }
33 |
34 | .edg {
35 | background-image: url("edge.svg");
36 | }
37 |
38 | .hide {
39 | display: none;
40 | }
41 |
42 | .sidebar {
43 | width: 215px;
44 | }
45 |
46 | @media screen and (max-width: 768px) {
47 | .logo {
48 | font-size: 16px;
49 | margin: 10px;
50 |
51 | img {
52 | width: 25px;
53 | margin: 0 10px 0 0;
54 | }
55 | }
56 |
57 | main {
58 | padding: 30px;
59 | display: flex;
60 | flex-direction: column;
61 | }
62 |
63 | .sidebar {
64 | width: 215px;
65 | margin: 2rem auto 0;
66 | }
67 |
68 | .explore-more, .demonstration-gif {
69 | display: none;
70 | }
71 |
72 | .content img {
73 | width: 100%;
74 | height: auto;
75 | }
76 | }
--------------------------------------------------------------------------------
/docs/static/banner.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/banner.png
--------------------------------------------------------------------------------
/docs/static/chrome.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/commands.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/commands.png
--------------------------------------------------------------------------------
/docs/static/cpp-search-extension.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/cpp-search-extension.gif
--------------------------------------------------------------------------------
/docs/static/edge.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/firefox.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/static/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/logo.png
--------------------------------------------------------------------------------
/docs/static/offline-mode.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/huhu/cpp-search-extension/565821eec89cc4dcf519ce9052b18dcb2c433ef2/docs/static/offline-mode.gif
--------------------------------------------------------------------------------
/docs/templates/_variables.html:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/docs/templates/index.html:
--------------------------------------------------------------------------------
1 | {% extends "juice/templates/index.html" %}
2 | {% block head %}
3 |
5 |
7 |
9 |
10 |
11 |
12 |
13 |
15 |
17 |
18 |
19 |
20 |
21 |
22 |
24 |
26 |
27 |
28 |
29 | {% endblock head %}
30 | {% block hero %}
31 |