feat: new sticky parameter (#51)

* Sort by a new `sticky` parameter

* Use timsort instead of lodash

* Update README.md

README.md

@@ -15,6 +15,7 @@ $ npm install hexo-generator-index --save
 ```
 
 ## Options
+
 Add or modify the following section to your root _config.yml file
 
 ``` yaml
@@ -36,6 +37,18 @@ index_generator:
   - default: 'page'
   - `awesome-page` makes the URL ends with 'awesome-page/<page number>' for second page and beyond.
 
+## Usage
+
+The `sticky` parameter in the post [Front-matter](https://hexo.io/docs/front-matter) will be used to pin the post to the top of the index page.
+
+```markdown
+---
+title: Hello World
+date: 2013/7/13 20:46:25
+sticky: 100
+---
+```
+
 ## Note
 
 If your theme define a non-archive `index` layout (e.g. About Me page), this plugin would follow that layout instead and not generate an archive. In that case, use [hexo-generator-archive](https://github.com/hexojs/hexo-generator-archive) to generate an archive according to the `archive` layout.

lib/generator.js

@@ -1,10 +1,14 @@
 'use strict';
 
 const pagination = require('hexo-pagination');
+const { sort } = require('timsort');
 
 module.exports = function(locals) {
   const config = this.config;
   const posts = locals.posts.sort(config.index_generator.order_by);
+
+  sort(posts.data, (a, b) => (b.sticky || 0) - (a.sticky || 0));
+
   const paginationDir = config.pagination_dir || 'page';
   const path = config.index_generator.path || '';
 

package.json

@@ -37,6 +37,7 @@
     "nyc": "^15.0.0"
   },
   "dependencies": {
-    "hexo-pagination": "1.0.0"
+    "hexo-pagination": "1.0.0",
+    "timsort": "^0.3.0"
   }
 }