浏览代码

Rename json_serializer plugin to tipue_search

This plugin is renamed after suggestions from @astorije and @ametaireau
which can be viewed
[here](https://github.com/getpelican/pelican-plugins/pull/66)
Talha Mansoor 10 年之前
父节点
当前提交
0cafe10d16
共有 4 个文件被更改,包括 11 次插入11 次删除
  1. 0 1
      json_serializer/__init__.py
  2. 6 6
      json_serializer/README.md
  3. 1 0
      tipue_search/__init__.py
  4. 4 4
      json_serializer/json_serializer.py

+ 0 - 1
json_serializer/__init__.py

@@ -1 +0,0 @@
-from .json_serializer import *

+ 6 - 6
json_serializer/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
 {

+ 1 - 0
tipue_search/__init__.py

@@ -0,0 +1 @@
+from .tipue_search import *

+ 4 - 4
json_serializer/json_serializer.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():