diff --git a/json_serializer/__init__.py b/json_serializer/__init__.py deleted file mode 100644 index c2de1ab..0000000 --- a/json_serializer/__init__.py +++ /dev/null @@ -1 +0,0 @@ -from .json_serializer import * diff --git a/json_serializer/README.md b/tipue_search/README.md similarity index 90% rename from json_serializer/README.md rename to tipue_search/README.md index 9e67630..80ac60f 100644 --- a/json_serializer/README.md +++ b/tipue_search/README.md @@ -1,7 +1,7 @@ -JSON Serializer -=============== +Tipue Search +============ -A Pelican plugin to serialize HTML output to JSON +A Pelican plugin to serialize generated HTML to JSON that can be used by jQuery plugin - Tipue Search. Copyright (c) Talha Mansoor @@ -25,16 +25,16 @@ Tipue's JSON search mode requires the textual content of site in JSON format. Requirements ============ -JSON Serializer requires BeautifulSoup. +Tipue Search requires BeautifulSoup. ```bash pip install beautifulsoup4 ``` -How JSON Serializer works +How Tipue Search works ========================= -JSON Serializer serializes the generated HTML into JSON. Format of JSON is as follows +Tipue Search serializes the generated HTML into JSON. Format of JSON is as follows ```python { diff --git a/tipue_search/__init__.py b/tipue_search/__init__.py new file mode 100644 index 0000000..ebd6c06 --- /dev/null +++ b/tipue_search/__init__.py @@ -0,0 +1 @@ +from .tipue_search import * diff --git a/json_serializer/json_serializer.py b/tipue_search/tipue_search.py similarity index 94% rename from json_serializer/json_serializer.py rename to tipue_search/tipue_search.py index 76bf5f3..2959076 100644 --- a/json_serializer/json_serializer.py +++ b/tipue_search/tipue_search.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """ -JSON Serializer -=============== +Tipue Search +============ A Pelican plugin to serialize generated HTML to JSON that can be used by jQuery plugin - Tipue Search. @@ -19,7 +19,7 @@ from codecs import open from pelican import signals -class JSON_Generator(object): +class Tipue_Search_JSON_Generator(object): def __init__(self, context, settings, path, theme, output_path, *null): @@ -69,7 +69,7 @@ class JSON_Generator(object): def get_generators(generators): - return JSON_Generator + return Tipue_Search_JSON_Generator def register():