PageRenderTime 44ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/README.md

https://gitlab.com/pelican-plugins/tipue_search
Markdown | 67 lines | 50 code | 17 blank | 0 comment | 0 complexity | 1a526ccb28872161f53b6bf61b748472 MD5 | raw file
    

  1. Tipue Search
    2. 

  2. ============
    3. 

  3. 

  4. A Pelican plugin to serialize generated HTML to JSON that can be used by jQuery plugin - Tipue Search.
    5. 

  5. 

  6. Copyright (c) Talha Mansoor
    7. 

  7. 

  8. Author          | Talha Mansoor
    9. 

  9. ----------------|-----
    10. 

  10. Author Email    | talha131@gmail.com 
    11. 

  11. Author Homepage | http://onCrashReboot.com 
    12. 

  12. Github Account  | https://github.com/talha131 
    13. 

  13. 

  14. Why do you need it?
    15. 

  15. ===================
    16. 

  16. 

  17. Static sites do not offer search feature out of the box. [Tipue Search](http://www.tipue.com/search/)
    18. 

  18. is a jQuery plugin that search the static site without using any third party service, like DuckDuckGo or Google.
    19. 

  19. 

  20. Tipue Search offers 4 search modes. Its [JSON search mode](http://www.tipue.com/search/docs/json/) is the best search mode
    21. 

  21. especially for large sites.
    22. 

  22. 

  23. Tipue's JSON search mode requires the textual content of site in JSON format.
    24. 

    25. 

  25. Requirements
    26. 

  26. ============
    27. 

  27. 

  28. Tipue Search requires BeautifulSoup.
    29. 

  29. 

  30. ```bash
    31. 

  31. pip install beautifulsoup4
    32. 

  32. ```
    33. 

  33. 

  34. How Tipue Search works
    35. 

  35. =========================
    36. 

  36. 

  37. Tipue Search serializes the generated HTML into JSON. Format of JSON is as follows
    38. 

  38. 

  39. ```python
    40. 

  40. {
    41. 

  41.     "pages": [
    42. 

  42.         { 
    43. 

  43.             "text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer nec odio. Praesent libero. Sed cursus ante dapibus diam. Sed nisi. Nulla quis sem at nibh elementum imperdiet. Duis sagittis ipsum. Praesent mauris. Fusce nec tellus sed augue semper porta. Mauris massa. Vestibulum lacinia arcu eget nulla. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Curabitur sodales ligula in libero.",
    44. 

  44.             "tags": "Example Category",
    45. 

  45.             "url" : "http://oncrashreboot.com/plugin-example.html",
    46. 

  46.             "title": "Everything you want to know about Lorem Ipsum"
    47. 

  47.         },
    48. 

  48.         { 
    49. 

  49.             "text": "Sed dignissim lacinia nunc. Curabitur tortor. Pellentesque nibh. Aenean quam. In scelerisque sem at dolor. Maecenas mattis. Sed convallis tristique sem. Proin ut ligula vel nunc egestas porttitor. Morbi lectus risus, iaculis vel, suscipit quis, luctus non, massa. Fusce ac turpis quis ligula lacinia aliquet. Mauris ipsum. Nulla metus metus, ullamcorper vel, tincidunt sed, euismod in, nibh.",
    50. 

  50.             "tags": "Example Category",
    51. 

  51.             "url" : "http://oncrashreboot.com/plugin-example-2.html",
    52. 

  52.             "title": "Review of the book Lorem Ipsum"
    53. 

  53.         }
    54. 

  54.     ]
    55. 

  55. }
    56. 

  56. ```
    57. 

  57. 

  58. JSON is written to file `tipuesearch_content.json` which is created in the root of `output` directory.
    59. 

  59. 

  60. How to use
    61. 

  61. ==========
    62. 

  62. 

  63. To utilize JSON Search mode, your theme needs to have Tipue Search properly configured in it. [Official documentation](http://www.tipue.com/search/docs/#json) has the required details.
    64. 

  64. 

  65. Pelican [Elegant Theme](https://github.com/talha131/pelican-elegant) and [Plumage
    66. 

  66. theme](https://github.com/kdeldycke/plumage) have Tipue Search configured. You can view their
    67. 

  67. code to understand the configuration.
    68. 

  68.