PageRenderTime 36ms CodeModel.GetById 10ms RepoModel.GetById 1ms app.codeStats 0ms

/README.md

https://github.com/varemenos/Doc-Finder
Markdown | 68 lines | 56 code | 12 blank | 0 comment | 0 complexity | f6ea2d2a7a2532ab6a30af63c393dd79 MD5 | raw file
  1. #DocFinder
  2. ##About
  3. An open source Documentation Searching webpage using searchco.de's API
  4. ##Search via url
  5. ###the "q" parameter
  6. setting the "q" url parameter to any string, will automatically insert that string in the keyword input and search for it once the page loads. For example: `?q=explode`
  7. ###the "lang" parameter
  8. setting the "lang" url parameter to a specific language name, will automatically pick that language from the dropdown menu when the page loads. For example: `?lang=php`
  9. valid options for the lang parameter are:
  10. <ul>
  11. <li>"all" for All</li>
  12. <li>"apache" for Apache 2 Directive</li>
  13. <li>"brainfuck" for BrainFuck</li>
  14. <li>"closure" for Closure</li>
  15. <li>"cobol" for Cobol</li>
  16. <li>"emacs" for Emacs</li>
  17. <li>"fossil_scm" for Fossil SCM</li>
  18. <li>"ftp" for FTP Code</li>
  19. <li>"git" for GIT</li>
  20. <li>"linux_cmd" for GNU/Linux Command</li>
  21. <li>"hello_world" for Hello World</li>
  22. <li>"hresult" for HResult</li>
  23. <li>"http" for HTTP Code</li>
  24. <li>"java" for Java</li>
  25. <li>"javascript" for Javascript</li>
  26. <li>"jquery" for JQuery</li>
  27. <li>"linux_kernel_error" for Linux Kernel Error</li>
  28. <li>"ios" for Mac iOS Reference</li>
  29. <li>"macos" for Mac OSX Reference</li>
  30. <li>"mercurial" for Mercurial</li>
  31. <li>"mysql_error" for MySQL Error</li>
  32. <li>"mysql" for MySQL Function</li>
  33. <li>"nginx" for Nginx HttpCoreModule</li>
  34. <li>"nt_status" for NT Status</li>
  35. <li>"perl5" for Perl 5</li>
  36. <li>"perl5_var" for Perl 5 Variable</li>
  37. <li>"php" for PHP</li>
  38. <li>"python" for Python</li>
  39. <li>"python_exception" for Python Exception</li>
  40. <li>"smarty" for Smarty</li>
  41. <li>"sql_server_2008" for SQL Server 2008 Function</li>
  42. <li>"sql_server_2008_error" for SQL Server Error</li>
  43. <li>"stuntsnippets" for stuntSnippets</li>
  44. <li>"svn" for SVN</li>
  45. <li>"underscorejs" for Underscore.js</li>
  46. <li>"visual_basic_6" for Visual Basic 6</li>
  47. <li>"win32_error" for Win 32 Error</li>
  48. <li>"windows_command" for Windows Command</li>
  49. </ul>
  50. ###"q" and "lang" parameters (together)
  51. You can use both of them at once for example: `?lang=php&q=explode`
  52. ## Android App
  53. get it from [here](https://play.google.com/store/apps/details?id=com.varemenos.docfinder)
  54. ## License
  55. docFinder by [Adonis K.](http://adonisk.com) is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US).
  56. [![Creative Commons License](http://i.creativecommons.org/l/by-nc-sa/3.0/88x31.png)](http://creativecommons.org/licenses/by-nc-sa/3.0/deed.en_US)