about_tmpl.coffee 5.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. app.templates.aboutPage = ->
  2. all_docs = app.docs.all().concat(app.disabledDocs.all()...)
  3. # de-duplicate docs by doc.name
  4. docs = []
  5. docs.push doc for doc in all_docs when not (docs.find (d) -> d.name == doc.name)
  6. """
  7. <nav class="_toc" role="directory">
  8. <h3 class="_toc-title">Table of Contents</h3>
  9. <ul class="_toc-list">
  10. <li><a href="#copyright">Copyright</a>
  11. <li><a href="#plugins">Plugins</a>
  12. <li><a href="#faq">FAQ</a>
  13. <li><a href="#credits">Credits</a>
  14. <li><a href="#privacy">Privacy Policy</a>
  15. </ul>
  16. </nav>
  17. <h1 class="_lined-heading">DevDocs: API Documentation Browser</h1>
  18. <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.
  19. <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>.
  20. <p>To keep up-to-date with the latest news:
  21. <ul>
  22. <li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
  23. <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>
  24. <li>Join the <a href="https://discord.gg/PRyKn3Vbay">Discord</a> chat room
  25. </ul>
  26. <h2 class="_block-heading" id="copyright">Copyright and License</h2>
  27. <p class="_note">
  28. <strong>Copyright 2013&ndash;2023 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
  29. This software is licensed under the terms of the Mozilla Public License v2.0.<br>
  30. You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
  31. For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/main/COPYRIGHT">COPYRIGHT</a>
  32. and <a href="https://github.com/freeCodeCamp/devdocs/blob/main/LICENSE">LICENSE</a> files.
  33. <h2 class="_block-heading" id="plugins">Plugins and Extensions</h2>
  34. <ul>
  35. <li><a href="https://sublime.wbond.net/packages/DevDocs">Sublime Text package</a>
  36. <li><a href="https://atom.io/packages/devdocs">Atom package</a>
  37. <li><a href="https://marketplace.visualstudio.com/items?itemName=deibit.devdocs">Visual Studio Code extension</a>
  38. <li><a href="https://github.com/yannickglt/alfred-devdocs">Alfred workflow</a>
  39. <li><a href="https://github.com/search?q=topic%3Adevdocs&type=Repositories">More…</a>
  40. </ul>
  41. <h2 class="_block-heading" id="faq">Questions & Answers</h2>
  42. <dl>
  43. <dt>Where can I suggest new docs and features?
  44. <dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
  45. If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
  46. Otherwise, come talk to us in the <a href="https://discord.gg/PRyKn3Vbay">Discord</a> chat room.
  47. <dt>Where can I report bugs?
  48. <dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
  49. </dl>
  50. <h2 class="_block-heading" id="credits">Credits</h2>
  51. <p><strong>Special thanks to:</strong>
  52. <ul>
  53. <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
  54. <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
  55. <li><a href="https://www.heroku.com">Heroku</a> and <a href="https://newrelic.com/">New Relic</a> for providing awesome free service
  56. <li><a href="https://www.jeremykratz.com/">Jeremy Kratz</a> for the C/C++ logo
  57. </ul>
  58. <div class="_table">
  59. <table class="_credits">
  60. <tr>
  61. <th>Documentation
  62. <th>Copyright/License
  63. <th>Source code
  64. #{(
  65. "<tr>
  66. <td><a href=\"#{doc.links.home}\">#{doc.name}</a></td>
  67. <td>#{doc.attribution}</td>
  68. <td><a href=\"#{doc.links.code}\">Source code</a></td>
  69. </tr>" for doc in docs
  70. ).join('')}
  71. </table>
  72. </div>
  73. <h2 class="_block-heading" id="privacy">Privacy Policy</h2>
  74. <ul>
  75. <li><a href="https://devdocs.io">devdocs.io</a> ("App") is operated by <a href="https://www.freecodecamp.org/">freeCodeCamp</a> ("We").
  76. <li>We do not collect personal information through the app.
  77. <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>.
  78. <li>We use Sentry to collect crash data and improve the app.
  79. <li>The app uses cookies to store user preferences.
  80. <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.
  81. <li>If you have any questions regarding privacy, please email <a href="mailto:privacy@freecodecamp.org">privacy@freecodecamp.org</a>.
  82. </ul>
  83. """