docsify-init.js 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
  1. let clink = null;
  2. if (window.DOCSIFY_ROUTER_MODE === "history") {
  3. clink = Docsify.dom.create("link");
  4. clink.rel = "canonical";
  5. Docsify.dom.appendTo(Docsify.dom.head, clink);
  6. }
  7. const documentTitleBase = document.title;
  8. const linksMenu = '<div class="links-menu">' +
  9. '<a href="https://imgproxy.net" target="_blank" title="Website"><img src="/assets/website.svg" /></a>' +
  10. '<a href="https://github.com/imgproxy" target="_blank" title="GitHub"><img src="/assets/github.svg" /></a>' +
  11. '<a href="https://twitter.com/imgproxy_net" target="_blank" title="Twitter"><img src="/assets/twitter.svg" /></a>' +
  12. '<a href="https://discord.gg/5GgpXgtC9u" target="_blank" title="Discord"><img src="/assets/discord.svg" /></a>' +
  13. '</div>';
  14. const docEditBase = 'https://github.com/imgproxy/imgproxy/edit/master/docs/';
  15. const proBadge = Docsify.dom.create("img");
  16. proBadge.setAttribute("src", "/assets/pro.svg");
  17. proBadge.setAttribute("title", "This feature is available in imgproxy Pro");
  18. const proBadgeRegex = /\!\[pro\]\((\S+)\)/g;
  19. const proLink = `<a class="badge" href="https://imgproxy.net/#pro" target="_blank">${proBadge.outerHTML}</a>`;
  20. const oldProBadge = "<i class='badge badge-pro'></i>";
  21. const defaultVersions = [["latest", "latest"]];
  22. const configureDocsify = (additionalVersions, latestVersion, latestTag) => {
  23. const versions = defaultVersions.concat(additionalVersions);
  24. const versionAliases = {};
  25. const versionSelect = ['<select id="version-selector" name="version" class="sidebar-version-select">'];
  26. versions.forEach(([version, tag]) => {
  27. const value = version == latestVersion ? "" : version;
  28. versionSelect.push(`<option value="${value}">${version}</value>`);
  29. if (version !== "latest") {
  30. versionAliases[`/${version}/(.*)`] =
  31. `https://raw.githubusercontent.com/imgproxy/imgproxy/${tag}/docs/$1`;
  32. versionAliases[`/${version}/`] =
  33. `https://raw.githubusercontent.com/imgproxy/imgproxy/${tag}/docs/README.md`;
  34. }
  35. });
  36. versionSelect.push('</select>');
  37. if (latestTag === "latest") latestTag = "master";
  38. window.$docsify = {
  39. name: '<a id="home-link" class="app-name-link" href="/"><img src="/assets/logo.svg"></a>' +
  40. linksMenu +
  41. versionSelect.join(""),
  42. nameLink: false,
  43. loadSidebar: true,
  44. relativePath: true,
  45. subMaxLevel: 3,
  46. auto2top: true,
  47. routerMode: window.DOCSIFY_ROUTER_MODE || "hash",
  48. noEmoji: true,
  49. alias: Object.assign(versionAliases, {
  50. '/latest/': 'README.md',
  51. '/latest/(.*)': '$1',
  52. '/([0-9]+\.[0-9]+)/(.*)': 'https://raw.githubusercontent.com/imgproxy/imgproxy/v$1.0/docs/$2',
  53. '/([0-9]+\.[0-9]+)/': 'https://raw.githubusercontent.com/imgproxy/imgproxy/v$1.0/docs/README.md',
  54. '/(.*)': `https://raw.githubusercontent.com/imgproxy/imgproxy/${latestTag}/docs/$1`,
  55. '/': `https://raw.githubusercontent.com/imgproxy/imgproxy/${latestTag}/docs/README.md`,
  56. }),
  57. search: {
  58. namespace: 'docs-imgproxy',
  59. depth: 6,
  60. // pathNamespaces: versions.map(v => "/" + v[0]),
  61. pathNamespaces: /^(\/(latest|([0-9]+\.[0-9]+)))?/,
  62. },
  63. namespaces: [
  64. {
  65. id: "version",
  66. values: versions.map(v => v[0]),
  67. optional: true,
  68. selector: "#version-selector",
  69. }
  70. ],
  71. plugins: window.$docsify.plugins.concat([
  72. (hook, vm) => {
  73. window.DocsifyVM = vm;
  74. hook.beforeEach(() => {
  75. if (clink)
  76. clink.href = "https://docs.imgproxy.net" + vm.route.path;
  77. });
  78. hook.doneEach(() => {
  79. const appNameLink = Docsify.dom.find("#home-link");
  80. if (!appNameLink) return;
  81. appNameLink.href = vm.config.currentNamespace;
  82. });
  83. hook.doneEach(() => {
  84. if (document.title != documentTitleBase)
  85. document.title += " | " + documentTitleBase;
  86. });
  87. hook.afterEach(html => {
  88. const docName = vm.route.file.replace(
  89. /https\:\/\/raw.githubusercontent\.com\/(.*)\/docs\//, ''
  90. );
  91. if (!docName) return html;
  92. const editButton = '<a class="github-edit-btn" title="Edit on GitHub" href="' +
  93. docEditBase + docName +
  94. '" target="_blank">' +
  95. 'Edit on <strong>GitHub</strong>' +
  96. '</a>';
  97. return html + editButton;
  98. })
  99. hook.beforeEach((content, next) => {
  100. content = content.replaceAll(proBadgeRegex, proLink);
  101. content = content.replaceAll(oldProBadge, proLink);
  102. next(content);
  103. })
  104. hook.doneEach(() => {
  105. const badges = Docsify.dom.findAll(".sidebar .badge-pro");
  106. badges.forEach(b => { b.replaceWith(proBadge.cloneNode()) });
  107. // Docsify cuts off "target" sometimes
  108. const links = Docsify.dom.findAll("a.badge");
  109. links.forEach(l => { l.setAttribute("target", "_blank") });
  110. })
  111. }
  112. ])
  113. }
  114. }
  115. const initDocsify = (versions, latestVersion, latestTag) => {
  116. configureDocsify(versions, latestVersion, latestTag);
  117. window.runDocsify();
  118. };
  119. const VERSIONS_KEY = "imgproxy.versions";
  120. const VERSIONS_ETAG_KEY = "imgproxy.versions.etag";
  121. let latestVersion = "latest";
  122. let latestTag = "latest";
  123. let storedVersions = [];
  124. let storedVersionsJson = localStorage.getItem(VERSIONS_KEY);
  125. let storedVersionsEtag = localStorage.getItem(VERSIONS_ETAG_KEY);
  126. if (storedVersionsJson) {
  127. try {
  128. storedVersions = JSON.parse(storedVersionsJson);
  129. } catch {
  130. storedVersions = [];
  131. }
  132. }
  133. if (storedVersions?.length)
  134. [latestVersion, latestTag] = storedVersions[0];
  135. else {
  136. // Just in case storedVersions is not an array
  137. storedVersions = [];
  138. storedVersionsEtag = null;
  139. }
  140. fetch(
  141. "https://api.github.com/repos/imgproxy/imgproxy/releases",
  142. {
  143. headers: {
  144. "Accept": "application/json",
  145. "If-None-Match": storedVersionsEtag,
  146. },
  147. },
  148. ).then((resp) => {
  149. if (resp.status === 304) {
  150. initDocsify(storedVersions, latestVersion, latestTag);
  151. return;
  152. }
  153. if (resp.status != 200)
  154. throw new Error(`Can't fetch imgproxy versions: ${resp.statusText}`);
  155. resp.json().then((data) => {
  156. const uniq = {};
  157. const fetchedVersions = [];
  158. data.forEach((release) => {
  159. if (release.draft || release.prerelease) return;
  160. var tag = release.tag_name;
  161. var matches = tag?.match(/^v([0-9]+\.[0-9]+)/);
  162. if (!matches?.length) return;
  163. var version = matches[1];
  164. if (uniq[version]) return;
  165. fetchedVersions.push([version, tag]);
  166. uniq[version] = true;
  167. });
  168. if (fetchedVersions.length)
  169. [latestVersion, latestTag] = fetchedVersions[0];
  170. localStorage.setItem(VERSIONS_KEY, JSON.stringify(fetchedVersions));
  171. localStorage.setItem(VERSIONS_ETAG_KEY, resp.headers.get("Etag"));
  172. initDocsify(fetchedVersions, latestVersion, latestTag);
  173. }).catch((e) => {
  174. initDocsify(storedVersions, latestVersion, latestTag);
  175. throw e;
  176. });
  177. }).catch((e) => {
  178. initDocsify(storedVersions, latestVersion, latestTag);
  179. throw e;
  180. });