about_tmpl.js 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. // TODO: This file was created by bulk-decaffeinate.
  2. // Sanity-check the conversion and remove this comment.
  3. /*
  4. * decaffeinate suggestions:
  5. * DS101: Remove unnecessary use of Array.from
  6. * DS102: Remove unnecessary code created because of implicit returns
  7. * DS205: Consider reworking code to avoid use of IIFEs
  8. * DS207: Consider shorter variations of null checks
  9. * Full docs: https://github.com/decaffeinate/decaffeinate/blob/main/docs/suggestions.md
  10. */
  11. app.templates.aboutPage = function () {
  12. let doc;
  13. const all_docs = app.docs
  14. .all()
  15. .concat(...Array.from(app.disabledDocs.all() || []));
  16. // de-duplicate docs by doc.name
  17. const docs = [];
  18. for (doc of Array.from(all_docs)) {
  19. if (!docs.find((d) => d.name === doc.name)) {
  20. docs.push(doc);
  21. }
  22. }
  23. return `\
  24. <nav class="_toc" role="directory">
  25. <h3 class="_toc-title">Table of Contents</h3>
  26. <ul class="_toc-list">
  27. <li><a href="#copyright">Copyright</a>
  28. <li><a href="#plugins">Plugins</a>
  29. <li><a href="#faq">FAQ</a>
  30. <li><a href="#credits">Credits</a>
  31. <li><a href="#privacy">Privacy Policy</a>
  32. </ul>
  33. </nav>
  34. <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1>
  35. <p>DevDocs combines multiple developer documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
  36. <p>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>. It was created by <a href="https://thibaut.me">Thibaut Courouble</a> and is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a>.
  37. <p>To keep up-to-date with the latest news:
  38. <ul>
  39. <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
  40. <li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a> <iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
  41. <li>Join the <a href="https://discord.gg/PRyKn3Vbay">Discord</a> chat room
  42. </ul>
  43. <h2 class="_block-heading" id="copyright">Copyright and License</h2>
  44. <p class="_note">
  45. <strong>Copyright 2013&ndash;2023 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
  46. This software is licensed under the terms of the Mozilla Public License v2.0.<br>
  47. You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
  48. For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/main/COPYRIGHT">COPYRIGHT</a>
  49. and <a href="https://github.com/freeCodeCamp/devdocs/blob/main/LICENSE">LICENSE</a> files.
  50. <h2 class="_block-heading" id="plugins">Plugins and Extensions</h2>
  51. <ul>
  52. <li><a href="https://sublime.wbond.net/packages/DevDocs">Sublime Text package</a>
  53. <li><a href="https://atom.io/packages/devdocs">Atom package</a>
  54. <li><a href="https://marketplace.visualstudio.com/items?itemName=deibit.devdocs">Visual Studio Code extension</a>
  55. <li><a href="https://github.com/yannickglt/alfred-devdocs">Alfred workflow</a>
  56. <li><a href="https://github.com/search?q=topic%3Adevdocs&type=Repositories">More…</a>
  57. </ul>
  58. <h2 class="_block-heading" id="faq">Questions & Answers</h2>
  59. <dl>
  60. <dt>Where can I suggest new docs and features?
  61. <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
  62. If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
  63. Otherwise, come talk to us in the <a href="https://discord.gg/PRyKn3Vbay">Discord</a> chat room.
  64. <dt>Where can I report bugs?
  65. <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
  66. </dl>
  67. <h2 class="_block-heading" id="credits">Credits</h2>
  68. <p><strong>Special thanks to:</strong>
  69. <ul>
  70. <li><a href="https://sentry.io/">Sentry</a> and <a href="https://get.gaug.es/?utm_source=devdocs&utm_medium=referral&utm_campaign=sponsorships" title="Real Time Web Analytics">Gauges</a> for offering a free account to DevDocs
  71. <li><a href="https://out.devdocs.io/s/maxcdn">MaxCDN</a>, <a href="https://out.devdocs.io/s/shopify">Shopify</a>, <a href="https://out.devdocs.io/s/jetbrains">JetBrains</a> and <a href="https://out.devdocs.io/s/code-school">Code School</a> for sponsoring DevDocs in the past
  72. <li><a href="https://www.heroku.com">Heroku</a> and <a href="https://newrelic.com/">New Relic</a> for providing awesome free service
  73. <li><a href="https://www.jeremykratz.com/">Jeremy Kratz</a> for the C/C++ logo
  74. </ul>
  75. <div class="_table">
  76. <table class="_credits">
  77. <tr>
  78. <th>Documentation
  79. <th>Copyright/License
  80. <th>Source code
  81. ${(() => {
  82. const result = [];
  83. for (doc of Array.from(docs)) {
  84. result.push(`<tr> \
  85. <td><a href=\"${doc.links != null ? doc.links.home : undefined}\">${
  86. doc.name
  87. }</a></td> \
  88. <td>${doc.attribution}</td> \
  89. <td><a href=\"${
  90. doc.links != null ? doc.links.code : undefined
  91. }\">Source code</a></td> \
  92. </tr>`);
  93. }
  94. return result;
  95. })().join("")}
  96. </table>
  97. </div>
  98. <h2 class="_block-heading" id="privacy">Privacy Policy</h2>
  99. <ul>
  100. <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
  101. <li>We do not collect personal information through the app.
  102. <li>We use Google Analytics and Gauges to collect anonymous traffic information if you have given consent to this. You can change your decision in the <a href="/settings">settings</a>.
  103. <li>We use Sentry to collect crash data and improve the app.
  104. <li>The app uses cookies to store user preferences.
  105. <li>By using the app, you signify your acceptance of this policy. If you do not agree to this policy, please do not use the app.
  106. <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.
  107. </ul>\
  108. `;
  109. };