mirror of
https://github.com/freeCodeCamp/devdocs
synced 2024-11-16 19:48:10 +01:00
DevDocs → freeCodeCamp
This commit is contained in:
Thibaut Courouble
parent
30a5774957
commit
d48396de57
11 changed files with 42 additions and 39 deletions
|
|
@ -24,7 +24,7 @@ Want to contribute? Great. Please review the following guidelines carefully and
|
|||
## Requesting new features
|
||||
|
||||
1. Search for similar feature requests; someone may have already requested it.
|
||||
2. Make sure your feature fits DevDocs's [vision](https://github.com/Thibaut/devdocs/blob/master/README.md#vision).
|
||||
2. Make sure your feature fits DevDocs's [vision](https://github.com/freeCodeCamp/devdocs/blob/master/README.md#vision).
|
||||
3. Provide a clear and detailed explanation of the feature and why it's important to add it.
|
||||
|
||||
For general feedback and ideas, please use the [mailing list](https://groups.google.com/d/forum/devdocs).
|
||||
|
|
@ -46,7 +46,7 @@ Use the [Trello board](https://trello.com/b/6BmTulfx/devdocs-documentation) wher
|
|||
|
||||
## Contributing new documentations
|
||||
|
||||
See the [wiki](https://github.com/Thibaut/devdocs/wiki) to learn how to add new documentations.
|
||||
See the [wiki](https://github.com/freeCodeCamp/devdocs/wiki) to learn how to add new documentations.
|
||||
|
||||
**Important:** the documentation's license must permit alteration, redistribution and commercial use, and the documented software must be released under an open source license. Feel free to get in touch if you're not sure if a documentation meets those requirements.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
<!--
|
||||
Please read the contributing guidelines before opening an issue:
|
||||
https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md
|
||||
https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md
|
||||
|
||||
To request a new documentation, or an update of an existing documentation, go here:
|
||||
https://trello.com/b/6BmTulfx/devdocs-documentation
|
||||
|
|
|
|||
20
README.md
20
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# [DevDocs](https://devdocs.io) [](https://travis-ci.org/Thibaut/devdocs)
|
||||
# [DevDocs](https://devdocs.io) [](https://travis-ci.org/freeCodeCamp/devdocs)
|
||||
|
||||
DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
|
||||
|
||||
|
|
@ -7,7 +7,7 @@ DevDocs combines multiple API documentations in a fast, organized, and searchabl
|
|||
Keep track of development news:
|
||||
|
||||
* Join the contributor chat room on [Gitter](https://gitter.im/FreeCodeCamp/DevDocs)
|
||||
* Watch the repository on [GitHub](https://github.com/Thibaut/devdocs/subscription)
|
||||
* Watch the repository on [GitHub](https://github.com/freeCodeCamp/devdocs/subscription)
|
||||
* Follow [@DevDocs](https://twitter.com/DevDocs) on Twitter
|
||||
* Join the [mailing list](https://groups.google.com/d/forum/devdocs)
|
||||
|
||||
|
|
@ -22,7 +22,7 @@ DevDocs is made of two pieces: a Ruby scraper that generates the documentation a
|
|||
DevDocs requires Ruby 2.5.0, libcurl, and a JavaScript runtime supported by [ExecJS](https://github.com/rails/execjs#readme) (included in OS X and Windows; [Node.js](https://nodejs.org/en/) on Linux). Once you have these installed, run the following commands:
|
||||
|
||||
```
|
||||
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
|
||||
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
|
||||
gem install bundler
|
||||
bundle install
|
||||
bundle exec thor docs:download --default
|
||||
|
|
@ -33,13 +33,13 @@ Finally, point your browser at [localhost:9292](http://localhost:9292) (the firs
|
|||
|
||||
The `thor docs:download` command is used to download pre-generated documentations from DevDocs's servers (e.g. `thor docs:download html css`). You can see the list of available documentations and versions by running `thor docs:list`. To update all downloaded documentations, run `thor docs:download --installed`.
|
||||
|
||||
**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/Thibaut/devdocs/subscription) this repository.
|
||||
**Note:** there is currently no update mechanism other than `git pull origin master` to update the code and `thor docs:download --installed` to download the latest version of the docs. To stay informed about new releases, be sure to [watch](https://github.com/freeCodeCamp/devdocs/subscription) this repository.
|
||||
|
||||
Alternatively, DevDocs may be started as a Docker container:
|
||||
|
||||
```
|
||||
# First, build the image
|
||||
git clone https://github.com/Thibaut/devdocs.git && cd devdocs
|
||||
git clone https://github.com/freeCodeCamp/devdocs.git && cd devdocs
|
||||
docker build -t thibaut/devdocs .
|
||||
|
||||
# Finally, start a DevDocs container (access http://localhost:9292)
|
||||
|
|
@ -93,7 +93,7 @@ These modifications are applied via a set of filters using the [HTML::Pipeline](
|
|||
|
||||
The end result is a set of normalized HTML partials and two JSON files (index + offline data). Because the index files are loaded separately by the [app](#app) following the user's preferences, the scraper also creates a JSON manifest file containing information about the documentations currently available on the system (such as their name, version, update date, etc.).
|
||||
|
||||
More information about scrapers and filters is available on the [wiki](https://github.com/Thibaut/devdocs/wiki).
|
||||
More information about scrapers and filters is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
|
||||
|
||||
## Available Commands
|
||||
|
||||
|
|
@ -133,15 +133,15 @@ If multiple versions of Ruby are installed on your system, commands must be run
|
|||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome. Please read the [contributing guidelines](https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md).
|
||||
Contributions are welcome. Please read the [contributing guidelines](https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md).
|
||||
|
||||
DevDocs's own documentation is available on the [wiki](https://github.com/Thibaut/devdocs/wiki).
|
||||
DevDocs's own documentation is available on the [wiki](https://github.com/freeCodeCamp/devdocs/wiki).
|
||||
|
||||
## Copyright / License
|
||||
|
||||
Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/Thibaut/devdocs/graphs/contributors)
|
||||
Copyright 2013-2018 Thibaut Courouble and [other contributors](https://github.com/freeCodeCamp/devdocs/graphs/contributors)
|
||||
|
||||
This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/Thibaut/devdocs/blob/master/LICENSE) files.
|
||||
This software is licensed under the terms of the Mozilla Public License v2.0. See the [COPYRIGHT](https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT) and [LICENSE](https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE) files.
|
||||
|
||||
Please do not use the name DevDocs to endorse or promote products derived from this software without my permission, except as may be necessary to comply with the notice/attribution requirements.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
[
|
||||
[
|
||||
"2018-03-26",
|
||||
"DevDocs is joining the freeCodeCamp community. Read the announcement <a href=\"https://medium.com/@quincylarson/devdocs-is-joining-the-freecodecamp-community-ae185a1c14a6\" target=\"_blank\">here</a>."
|
||||
], [
|
||||
"2018-02-04",
|
||||
"New documentations: <a href=\"/babel/\">Babel</a>, <a href=\"/jekyll/\">Jekyll</a> and <a href=\"/jsdoc/\">JSDoc</a>"
|
||||
], [
|
||||
|
|
@ -7,7 +10,7 @@
|
|||
"New documentations: <a href=\"/bluebird/\">Bluebird</a>, <a href=\"/eslint/\">ESLint</a> and <a href=\"/homebrew/\">Homebrew</a>"
|
||||
], [
|
||||
"2017-11-18",
|
||||
"Added print & PDF stylesheet.\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/Thibaut/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
|
||||
"Added print & PDF stylesheet.\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/freeCodeCamp/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
|
||||
], [
|
||||
"2017-09-10",
|
||||
"<a href=\"/settings\">Preferences</a> can now be exported and imported."
|
||||
|
|
@ -119,7 +122,7 @@
|
|||
"New documentations: <a href=\"/q/\">Q</a> and <a href=\"/opentsdb/\">OpenTSDB</a>"
|
||||
], [
|
||||
"2015-07-26",
|
||||
"Added search aliases (e.g. <code class=\"_label\">$</code> is an alias for <code class=\"_label\">jQuery</code>).\n<a href=\"/help#aliases\">Click here</a> to see the full list. Feel free to suggest more on <a href=\"https://github.com/Thibaut/devdocs/issues/new\" target=\"_blank\" rel=\"noopener\">GitHub</a>.",
|
||||
"Added search aliases (e.g. <code class=\"_label\">$</code> is an alias for <code class=\"_label\">jQuery</code>).\n<a href=\"/help#aliases\">Click here</a> to see the full list. Feel free to suggest more on <a href=\"https://github.com/freeCodeCamp/devdocs/issues/new\" target=\"_blank\" rel=\"noopener\">GitHub</a>.",
|
||||
"Added <code class=\"_label\">shift + ↓/↑</code> shortcut for scrolling (same as <code class=\"_label\">alt + ↓/↑</code>)."
|
||||
], [
|
||||
"2015-07-05",
|
||||
|
|
@ -160,7 +163,7 @@
|
|||
"New <a href=\"/python2/\">Python 2</a> documentation"
|
||||
], [
|
||||
"2014-11-09",
|
||||
"New design\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/Thibaut/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
|
||||
"New design\nFeedback welcome on <a href=\"https://twitter.com/DevDocs\" target=\"_blank\" rel=\"noopener\">Twitter</a> and <a href=\"https://github.com/freeCodeCamp/devdocs\" target=\"_blank\" rel=\"noopener\">GitHub</a>."
|
||||
], [
|
||||
"2014-10-19",
|
||||
"New <a href=\"/svg/\">SVG</a>, <a href=\"/marionette/\">Marionette.js</a>, and <a href=\"/mongoose/\">Mongoose</a> documentations"
|
||||
|
|
@ -245,7 +248,7 @@
|
|||
"New <a href=\"/ruby/\">Ruby</a> documentation"
|
||||
], [
|
||||
"2013-10-24",
|
||||
"DevDocs is now <a href=\"https://github.com/Thibaut/devdocs\">open source</a>."
|
||||
"DevDocs is now <a href=\"https://github.com/freeCodeCamp/devdocs\">open source</a>."
|
||||
], [
|
||||
"2013-10-09",
|
||||
"DevDocs is now available as a <a href=\"https://chrome.google.com/webstore/detail/devdocs/mnfehgbmkapmjnhcnbodoamcioleeooe\">Chrome web app</a>."
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ app.templates.notifError = ->
|
|||
textNotif """ Oops, an error occurred. """,
|
||||
""" Try <a href="#" data-behavior="hard-reload">reloading</a>, and if the problem persists,
|
||||
<a href="#" data-behavior="reset">resetting the app</a>.<br>
|
||||
You can also report this issue on <a href="https://github.com/Thibaut/devdocs/issues/new" target="_blank" rel="noopener">GitHub</a>. """
|
||||
You can also report this issue on <a href="https://github.com/freeCodeCamp/devdocs/issues/new" target="_blank" rel="noopener">GitHub</a>. """
|
||||
|
||||
app.templates.notifQuotaExceeded = ->
|
||||
textNotif """ The offline database has exceeded its size limitation. """,
|
||||
|
|
|
|||
|
|
@ -14,23 +14,23 @@ app.templates.aboutPage = -> """
|
|||
<p>DevDocs combines multiple API documentations in a clean and organized web UI with instant search, offline support, mobile version, dark theme, keyboard shortcuts, and more.
|
||||
<ul>
|
||||
<li>Created and maintained by <a href="https://thibaut.me">Thibaut Courouble</a>
|
||||
<li>Free and <a href="https://github.com/Thibaut/devdocs">open source</a>
|
||||
<iframe class="_github-btn" src="https://ghbtns.com/github-btn.html?user=Thibaut&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20" tabindex="-1"></iframe>
|
||||
<li>Free and <a href="https://github.com/freeCodeCamp/devdocs">open source</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>
|
||||
</ul>
|
||||
<p>To keep up-to-date with the latest news:
|
||||
<ul>
|
||||
<li>Follow <a href="https://twitter.com/DevDocs">@DevDocs</a> on Twitter
|
||||
<li>Watch the repository on <a href="https://github.com/Thibaut/devdocs/subscription">GitHub</a>
|
||||
<li>Watch the repository on <a href="https://github.com/freeCodeCamp/devdocs/subscription">GitHub</a>
|
||||
<li>Join the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>
|
||||
</ul>
|
||||
|
||||
<h2 class="_block-heading" id="copyright">Copyright and License</h2>
|
||||
<p class="_note">
|
||||
<strong>Copyright 2013–2018 Thibaut Courouble and <a href="https://github.com/Thibaut/devdocs/graphs/contributors">other contributors</a></strong><br>
|
||||
<strong>Copyright 2013–2018 Thibaut Courouble and <a href="https://github.com/freeCodeCamp/devdocs/graphs/contributors">other contributors</a></strong><br>
|
||||
This software is licensed under the terms of the Mozilla Public License v2.0.<br>
|
||||
You may obtain a copy of the source code at <a href="https://github.com/Thibaut/devdocs">github.com/Thibaut/devdocs</a>.<br>
|
||||
For more information, see the <a href="https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
|
||||
and <a href="https://github.com/Thibaut/devdocs/blob/master/LICENSE">LICENSE</a> files.
|
||||
You may obtain a copy of the source code at <a href="https://github.com/freeCodeCamp/devdocs">github.com/freeCodeCamp/devdocs</a>.<br>
|
||||
For more information, see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a>
|
||||
and <a href="https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE">LICENSE</a> files.
|
||||
|
||||
<h2 class="_block-heading" id="plugins">Plugins and Extensions</h2>
|
||||
<ul>
|
||||
|
|
@ -47,10 +47,10 @@ app.templates.aboutPage = -> """
|
|||
<dl>
|
||||
<dt>Where can I suggest new docs and features?
|
||||
<dd>You can suggest and vote for new docs on the <a href="https://trello.com/b/6BmTulfx/devdocs-documentation">Trello board</a>.<br>
|
||||
If you have a specific feature request, add it to the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>.<br>
|
||||
If you have a specific feature request, add it to the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>.<br>
|
||||
Otherwise use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
|
||||
<dt>Where can I report bugs?
|
||||
<dd>In the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>. Thanks!
|
||||
<dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
|
||||
</dl>
|
||||
<p>For anything else, feel free to email me at <a href="mailto:thibaut@devdocs.io">thibaut@devdocs.io</a>.
|
||||
|
||||
|
|
|
|||
|
|
@ -151,5 +151,5 @@ app.templates.helpPage = ->
|
|||
#{("<tr><td class=\"_code\">#{key}<td class=\"_code\">#{value}" for key, value of aliases_two).join('')}
|
||||
</table>
|
||||
</div>
|
||||
<p>Feel free to suggest new aliases on <a href="https://github.com/Thibaut/devdocs/issues/new">GitHub</a>.
|
||||
<p>Feel free to suggest new aliases on <a href="https://github.com/freeCodeCamp/devdocs/issues/new">GitHub</a>.
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ app.templates.newsPage = ->
|
|||
""" <h1 class="_lined-heading">Changelog</h1>
|
||||
<p class="_note">
|
||||
For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.<br>
|
||||
For development updates, follow the project on <a href="https://github.com/Thibaut/devdocs">GitHub</a>.
|
||||
For development updates, follow the project on <a href="https://github.com/freeCodeCamp/devdocs">GitHub</a>.
|
||||
<div class="_news">#{app.templates.newsList app.news}</div> """
|
||||
|
||||
app.templates.newsList = (news, options = {}) ->
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ app.templates.offlinePage = (docs) -> """
|
|||
<dt>What if I don't update a documentation?
|
||||
<dd>You'll see outdated content and some pages will be missing or broken, because the rest of the app (including data for the search and sidebar) uses a different caching mechanism that's updated automatically.
|
||||
<dt>I found a bug, where do I report it?
|
||||
<dd>In the <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a>. Thanks!
|
||||
<dd>In the <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a>. Thanks!
|
||||
<dt>How do I uninstall/reset the app?
|
||||
<dd>Click <a href="#" data-behavior="reset">here</a>.
|
||||
<dt>Why aren't all documentations listed above?
|
||||
|
|
|
|||
|
|
@ -12,13 +12,13 @@ app.templates.intro = """
|
|||
<li>Run <code>thor docs:list</code> to see all available documentations.
|
||||
<li>Run <code>thor docs:download <name></code> to download documentations.
|
||||
<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.
|
||||
<li>To be notified about new versions, don't forget to <a href="https://github.com/Thibaut/devdocs/subscription">watch the repository</a> on GitHub.
|
||||
<li>The <a href="https://github.com/Thibaut/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
|
||||
<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.
|
||||
<li>The <a href="https://github.com/freeCodeCamp/devdocs/issues">issue tracker</a> is the preferred channel for bug reports and
|
||||
feature requests. For everything else, use the <a href="https://groups.google.com/d/forum/devdocs">mailing list</a>.
|
||||
<li>Contributions are welcome. See the <a href="https://github.com/Thibaut/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
|
||||
<li>Contributions are welcome. See the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/CONTRIBUTING.md">guidelines</a>.
|
||||
<li>DevDocs is licensed under the terms of the Mozilla Public License v2.0. For more information,
|
||||
see the <a href="https://github.com/Thibaut/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and
|
||||
<a href="https://github.com/Thibaut/devdocs/blob/master/LICENSE">LICENSE</a> files.
|
||||
see the <a href="https://github.com/freeCodeCamp/devdocs/blob/master/COPYRIGHT">COPYRIGHT</a> and
|
||||
<a href="https://github.com/freeCodeCamp/devdocs/blob/master/LICENSE">LICENSE</a> files.
|
||||
</ol>
|
||||
<p>Happy coding!
|
||||
</div></div>
|
||||
|
|
@ -38,8 +38,8 @@ app.templates.intro = """
|
|||
<li>You can search using your browser's address bar — <a href="/help#browser_search">learn how</a>.
|
||||
<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>.
|
||||
<li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
|
||||
<li>DevDocs is free and <a href="https://github.com/Thibaut/devdocs">open source</a>.
|
||||
<iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=Thibaut&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
|
||||
<li>DevDocs is free and <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
|
||||
<iframe class="_github-btn" src="//ghbtns.com/github-btn.html?user=freeCodeCamp&repo=devdocs&type=watch&count=true" allowtransparency="true" frameborder="0" scrolling="0" width="100" height="20"></iframe>
|
||||
<li>And if you're new to coding, check out <a href="https://www.freecodecamp.org/">freeCodeCamp's open source curriculum</a>.
|
||||
</ol>
|
||||
<p>Happy coding!
|
||||
|
|
@ -57,7 +57,7 @@ app.templates.mobileIntro = """
|
|||
<li>The search supports fuzzy matching.
|
||||
<li>To search a specific documentation, type its name (or an abbr.), then Space.
|
||||
<li>For the latest news, follow <a href="https://twitter.com/DevDocs">@DevDocs</a>.
|
||||
<li>DevDocs is <a href="https://github.com/Thibaut/devdocs">open source</a>.
|
||||
<li>DevDocs is <a href="https://github.com/freeCodeCamp/devdocs">open source</a>.
|
||||
</ol>
|
||||
<p>Happy coding!
|
||||
<a class="_intro-hide" data-hide-intro>Stop showing this message</a>
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ class app.views.Resizer extends app.View
|
|||
onDragEnd: (event) =>
|
||||
$.off(window, 'dragover', @onDrag)
|
||||
value = event.pageX or (event.screenX - window.screenX)
|
||||
if @lastDragValue and not (@lastDragValue - 5 < value < @lastDragValue + 5) # https://github.com/Thibaut/devdocs/issues/265
|
||||
if @lastDragValue and not (@lastDragValue - 5 < value < @lastDragValue + 5) # https://github.com/freeCodeCamp/devdocs/issues/265
|
||||
value = @lastDragValue
|
||||
@resize(value, true)
|
||||
return
|
||||
|
|
|
|||
Loading…
Reference in a new issue