root_tmpl.coffee.erb 4.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. app.templates.splash = """<div class="_splash-title">DevDocs</div>"""
  2. <% if App.development? %>
  3. app.templates.intro = """
  4. <div class="_intro"><div class="_intro-message">
  5. <a href="#" class="_intro-hide" data-hide-intro>Stop showing this message</a>
  6. <h2 class="_intro-title">Hi there!</h2>
  7. <p>Thanks for downloading DevDocs. Here are a few things you should know:
  8. <ol class="_intro-list">
  9. <li>Your local version of DevDocs won't self-update. Unless you're modifying the code,
  10. we&nbsp;recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.
  11. <li>Run <code>thor docs:list</code> to see all available documentations.
  12. <li>Run <code>thor docs:download &lt;name&gt;</code> to download documentations.
  13. <li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
  14. <li>To be notified about new versions, don't forget to <a href="https://github.com/freeCodeCamp/devdocs/subscription">watch the repository</a> on GitHub.
  15. <li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
  16. feature requests. For everything else, use <a href="https://gitter.im/FreeCodeCamp/DevDocs">Gitter</a>.
  17. <li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/main/CONTRIBUTING.md">guidelines</a>.
  18. <li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
  19. see the <a href="https://github.com/freeCodeCamp/devdocs/blob/main/COPYRIGHT">COPYRIGHT</a> and
  20. <a href="https://github.com/freeCodeCamp/devdocs/blob/main/LICENSE">LICENSE</a> files.
  21. </ol>
  22. <p>Happy coding!
  23. </div></div>
  24. """
  25. <% else %>
  26. app.templates.intro = """
  27. <div class="_intro"><div class="_intro-message">
  28. <a href="#" class="_intro-hide" data-hide-intro>Stop showing this message</a>
  29. <h2 class="_intro-title">Welcome!</h2>
  30. <p>DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
  31. Here's what you should know before you start:
  32. <ol class="_intro-list">
  33. <li>Open the <a href="/settings">Preferences</a> to enable more docs and customize the UI.
  34. <li>You don't have to use your mouse &mdash; see the list of <a href="/help#shortcuts">keyboard shortcuts</a>.
  35. <li>The search supports fuzzy matching (e.g. "bgcp" brings up "background-clip").
  36. <li>To search a specific documentation, type its name (or an abbr.), then Tab.
  37. <li>You can search using your browser's address bar &mdash; <a href="/help#browser_search">learn how</a>.
  38. <li>DevDocs works <a href="/offline">offline</a>, on mobile, and can be installed on <a href="https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe">Chrome</a>.
  39. <li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
  40. <li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
  41. <object data="https://img.shields.io/github/stars/freeCodeCamp/devdocs.svg?style=social" type="image/svg+xml" aria-hidden="true" height="20"></object>
  42. <li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>.
  43. </ol>
  44. <p>Happy coding!
  45. </div></div>
  46. """
  47. <% end %>
  48. app.templates.mobileIntro = """
  49. <div class="_mobile-intro">
  50. <h2 class="_intro-title">Welcome!</h2>
  51. <p>DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
  52. Here's what you should know before you start:
  53. <ol class="_intro-list">
  54. <li>Pick your docs in the <a href="/settings">Preferences</a>.
  55. <li>The search supports fuzzy matching.
  56. <li>To search a specific documentation, type its name (or an abbr.), then Space.
  57. <li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
  58. <li>DevDocs is <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
  59. </ol>
  60. <p>Happy coding!
  61. <a class="_intro-hide" data-hide-intro>Stop showing this message</a>
  62. </div>
  63. """
  64. app.templates.androidWarning = """
  65. <div class="_mobile-intro">
  66. <h2 class="_intro-title">Hi there</h2>
  67. <p>DevDocs is running inside an Android WebView. Some features may not work properly.
  68. <p>If you downloaded an app called DevDocs on the Play Store, please uninstall it — it's made by someone who is using (and profiting from) the name DevDocs without permission.
  69. <p>To install DevDocs on your phone, visit <a href="https://devdocs.io" target="_blank" rel="noopener">devdocs.io</a> in Chrome and select "Add to home screen" in the menu.
  70. </div>
  71. """