docs/store.html at main · degoog-org/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<!doctype html>
<html lang="en" data-theme="light">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <title>Store repositories - Degoog docs</title>
    <script>
      (function () {
        try {
          var t = localStorage.getItem("ade:theme");
          if (t !== "light" && t !== "dark") {
            t = window.matchMedia("(prefers-color-scheme: dark)").matches
              ? "dark"
              : "light";
          }
          document.documentElement.setAttribute("data-theme", t);
        } catch (e) {}
      })();
    </script>
    <link
      rel="icon"
      href="https://github.com/fccview/degoog/raw/main/src/public/images/degoog-logo.png"
    />
    <link
      rel="stylesheet"
      href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.0/css/all.min.css"
    />
    <link rel="preconnect" href="https://fonts.googleapis.com" />
    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
    <link
      rel="stylesheet"
      href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap"
    />
    <link rel="stylesheet" href="style.css?cache=burstthefucker" />
  </head>
  <body>
    <div class="degoog-docs-layout">
      <header class="degoog-docs-mobile-header">
        <button id="degoog-docs-burger" type="button" class="degoog-docs-btn degoog-docs-btn-burger">
          <i class="fa-solid fa-bars"></i>
        </button>
        <span class="degoog-docs-mobile-title">Degoog Docs</span>
      </header>
      <div class="degoog-docs-content">
        <aside class="degoog-docs-sidebar">
          <div class="degoog-docs-sidebar-brand">
            <img
              src="https://github.com/fccview/degoog/raw/main/src/public/images/degoog-logo.png"
              alt="degoog logo"
              class="degoog-docs-brand-img"
              onerror="this.style.display = 'none'"
            />
            <a href="index.html" class="degoog-docs-brand-name">Degoog Docs</a>
          </div>
          <div class="degoog-docs-sidebar-search">
            <div class="doc-search-wrap">
              <input
                type="search"
                id="doc-search-input"
                class="degoog-docs-input doc-search"
                placeholder="Search docs..."
                autocomplete="off"
              />
              <button
                type="button"
                class="doc-search-clear degoog-docs-btn"
                aria-label="Clear search"
                style="display: none"
              >
                Clear
              </button>
              <span class="doc-search-count"></span>
            </div>
          </div>
          <nav class="degoog-docs-nav" aria-label="Documentation">
            <a href="index.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-book-open fa-lg"></i></i
              ><span class="degoog-docs-nav-item-name">Overview</span></a
            >
            <a href="plugins.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-puzzle-piece fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Plugins</span></a
            >
            <a href="shortcuts.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-arrow-down-a-z fa-lg"></i></i
              ><span class="degoog-docs-nav-item-name"> Shortcuts</span></a
            >
            <a href="themes.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-palette fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Themes</span></a
            >
            <a href="engines.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-bolt fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Search engines</span></a
            >
            <a href="autocomplete.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-keyboard fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Autocomplete</span></a
            >
            <a href="transports.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-network-wired fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Transports</span></a
            >
            <a href="store.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-store fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Store</span></a
            >
            <a href="aliases.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-link fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Aliases</span></a
            >
            <a href="env.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-lock fa-lg"></i></i
              ><span class="degoog-docs-nav-item-name">ENV Variables</span></a
            >
            <a href="styling.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-swatchbook fa-lg"></i></i
              ><span class="degoog-docs-nav-item-name"> Styling</span></a
            >
            <a href="translations.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-language fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> Translations</span></a
            >
            <a href="api.html" class="degoog-docs-nav-item"
              ><i class="fa-solid fa-code fa-lg"></i
              ><span class="degoog-docs-nav-item-name"> API</span></a
            >
          </nav>
          <div class="degoog-docs-sidebar-actions">
            <button
              id="doc-theme-toggle"
              type="button"
              class="degoog-docs-btn"
              aria-label="Toggle theme"
            >
              <i class="fa-solid fa-circle-half-stroke"></i>
            </button>
          </div>
        </aside>
        <main class="degoog-docs-main">
          <div class="doc-page-header">
            <h1><a href="index.html">Degoog</a> Store repositories</h1>
            <p class="doc-page-desc">
              Git repositories you can add in Settings then Store to easily
              install plugins, themes, and engines.
            </p>
          </div>

          <h2>What a store repo is</h2>
          <p>
            A <strong>store repo</strong> is a Git repository you can link to
            Degoog by going to <strong>Settings</strong> then
            <strong>Store</strong>. Once you add it, you can browse and install
            plugins, themes, engines, and transports directly from the Store tab
            without having to copy files manually.
          </p>

          <h2>Repo structure</h2>
          <p>Your repository needs to follow this layout:</p>
          <pre><code>my-degoog-repo/
  package.json
  plugins/
    my-plugin/
      index.js
      template.html
      style.css
  themes/
    my-theme/
      theme.json
      style.css
  engines/
    my-engine/
      index.js
  transports/
    my-transport/
      index.js</code></pre>
          <p>
            Your plugin, theme, engine, and transport folders use the exact same
            format as they do when installed directly in your
            <code>data</code> folders. You do not need any extra packaging.
          </p>

          <h2>package.json (required)</h2>
          <p>
            At the root of your repository, you need to add a
            <code>package.json</code> file that lists every item you want to
            show up in the Store:
          </p>
          <pre><code>{
  "name": "my-degoog-repo",
  "description": "Short description of your collection",
  "author": "YourName",
  "plugins": [
    {
      "path": "plugins/my-plugin",
      "name": "My Plugin",
      "description": "What it does",
      "version": "1.0.0",
      "type": "command"
    }
  ],
  "themes": [
    {
      "path": "themes/my-theme",
      "name": "My Theme",
      "description": "Short description",
      "version": "1.0.0"
    }
  ],
  "engines": [],
  "transports": [],
  "repo-image": "logo.png"
}</code></pre>
          <ul>
            <li>
              <strong>repo-image</strong> (optional): The path to an image file
              in your repository root like <code>logo.png</code> or a full URL.
              This displays right next to your repository in Settings then
              Store.
            </li>
            <li>
              <strong>path</strong>: The folder path inside your repository.
            </li>
            <li>
              <strong>name</strong>, <strong>description</strong>, and
              <strong>version</strong>: These details are displayed on the Store
              card.
            </li>
            <li>
              <strong>type</strong> (plugins only): You can use
              <code>command</code>, <code>slot</code>, <code>searchBar</code>,
              or <code>search-result-tab</code>. This is optional and helps with
              the Store display.
            </li>
            <li>
              <strong>dependencies</strong> (optional): An array of URLs for
              things like required engines. When someone installs your item,
              these dependencies are offered to them automatically.
            </li>
          </ul>
          <p>
            Only the items you explicitly list here will appear in the Store.
            Make sure your paths match your actual folders.
          </p>

          <h2>Optional author.json and screenshots</h2>
          <p>
            Inside any plugin, theme, engine, or transport folder you can
            include a few extra details:
          </p>
          <ul>
            <li>
              <strong>author.json</strong>: This file overrides the main
              repository author for a specific item.
            </li>
          </ul>
          <pre><code>{
  "name": "Author Name",
  "url": "https://github.com/username",
  "avatar": "https://example.com/avatar.png"
}</code></pre>
          <ul>
            <li>
              <strong>screenshots/</strong>: A folder containing image files
              like <code>1.png</code> or <code>preview.png</code>. The very
              first image acts as the Store card thumbnail, and all of them are
              visible in the lightbox when a user clicks the image.
            </li>
          </ul>

          <h2>Publish and share</h2>
          <ol>
            <li>Push your repository to GitHub or any other Git host.</li>
            <li>Copy the clone URL.</li>
            <li>
              Tell your users to go to <strong>Settings</strong> then
              <strong>Store</strong> then <strong>Add</strong> and paste your
              URL.
            </li>
          </ol>
          <p>
            Users only need to add your repository once. After that, they can
            easily install, uninstall, and refresh items directly from the
            Store. When someone refreshes a repository, their installed items
            are automatically updated to the latest version.
          </p>
          <p>
            <strong>Official example:</strong> The
            <a
              href="https://github.com/degoog-org/official-extensions"
              class="external"
              target="_blank"
              rel="noopener"
              >official extensions repository</a
            >
            uses the clone URL
            <code>https://github.com/degoog-org/official-extensions.git</code>.
            Just add it to your Store to install the Weather plugin, fresh
            themes, and other great extensions.
          </p>

          <h2>Community extensions</h2>
          <p>
            We want to give a massive thank you to our community for building
            and sharing their own plugins and engines. You can discover all of
            these over at the
            <a
              href="https://degoog-org.github.io/community-extensions/"
              class="external"
              target="_blank"
              rel="noopener"
              >community extensions page</a
            >. Please remember that because these are created by other users, we
            do not officially vet them or take any responsibility for them.
            Always make sure you double check what you are installing on your
            system before adding it.
          </p>
        </main>
      </div>
      <div id="degoog-docs-backdrop" class="degoog-docs-backdrop"></div>
    </div>
    <script
      src="https://code.jquery.com/jquery-4.0.0.min.js"
      crossorigin="anonymous"
    ></script>
    <script src="docs.js"></script>
    <script src="docs-ui.js"></script>
  </body>
</html>