Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimaslanjaka/hexo-seo
Automated Search Engine Optimization (SEO) for Hexo
https://github.com/dimaslanjaka/hexo-seo
hexo hexo-plugin hexo-seo javascript seo seo-optimization typescript
Last synced: about 2 months ago
JSON representation
Automated Search Engine Optimization (SEO) for Hexo
- Host: GitHub
- URL: https://github.com/dimaslanjaka/hexo-seo
- Owner: dimaslanjaka
- License: apache-2.0
- Created: 2021-11-11T13:15:19.000Z (about 3 years ago)
- Default Branch: pre-release
- Last Pushed: 2024-10-24T04:12:57.000Z (2 months ago)
- Last Synced: 2024-10-24T19:09:33.421Z (about 2 months ago)
- Topics: hexo, hexo-plugin, hexo-seo, javascript, seo, seo-optimization, typescript
- Language: TypeScript
- Homepage: https://webmanajemen.com
- Size: 97.7 MB
- Stars: 15
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# hexo-seo
Automated Hexo Seo Optimizer.
[](https://github.com/dimaslanjaka/source-posts/actions/workflows/build-site-reusable.yml)
# Features
- Auto add anchor title (if not exists)
- Auto determine anchor external link and nofollow them
- ~Auto replace broken images~
- Auto compress CSS JS HTML
- Auto add alternate and title of images
- Auto add sitemap (forked from **yoast seo wordpress plugin**)
- Auto add [google news sitemap](https://www.npmjs.com/package/google-news-sitemap)
- Tested on hexo instances with 1000 more posts and pages
- Concatenate all javascripts into one file
- Rich snippets (breadcrumbs, website, article)
> ## The reason why some features are removed
> Separated due to very high memory usage and risk of HEAP MEMORY errors. so I will merge it to https://github.com/dimaslanjaka/static-blog-generator as a specific task
# demo
demo site generated with `hexo-seo`
- [YoastSEO sitemap](https://www.webmanajemen.com/sitemap.xml)
- [Rich Snippet](https://search.google.com/test/rich-results?hl=en&url=https%3A%2F%2Fwww.webmanajemen.com%2Fchimeraland%2Fblacklist-player.html)
# Installation
Using NPM Repository (Production)
```shell
npm i hexo-seo
```
Using Git Repository (Development)
```shell
npm i git+https://github.com/dimaslanjaka/hexo-seo.git#pre-release
```
### Packages Links
> Using tarball is useful for git which not installed properly or for you in chinese mainland
| description | link |
| :--- | :--- |
| master tarball | https://github.com/dimaslanjaka/hexo-seo/raw/master/release/hexo-seo.tgz |
| pre-release tarball | https://github.com/dimaslanjaka/hexo-seo/raw/pre-release/release/hexo-seo.tgz |
> you can change `master` or `pre-release` with spesific **commit hash**
# Usage
## Configuration
[config full example](https://github.com/dimaslanjaka/site/blob/hexo-seo/_config.yml#L138)
```yaml
# https://github.com/dimaslanjaka/hexo-seo
seo:
# minify html
html:
enable: true
# fix invalid html
fix: true
# exclude from minify
exclude:
- "*.min.{htm,html}"
# minify css
css:
enable: true
# If you want to customize the css minifier settings, you can put below
# exclude css from minifying, multiple supported
exclude:
- "**/*.min.css"
# minify js
js:
enable: true
# concatenate all js into one tag
## WARNING: DO NOT USING ANOTHER MINIFIER PLUGIN
concat: false
# If you want to customize the js minifier settings, you can put below
# exclude css from minifying, multiple supported
exclude:
- "**/*.min.js"
# this is terser options, you can customize minifier with terser options
# https://github.com/terser/terser?tab=readme-ov-file#minify-options-structure
# below is config example
options:
compress:
dead_code: true
mangle:
toplevel: true
safari10: true
# rich snippets
schema:
# produce schema for page and post
article:
enable: true
# produce schema for breadcrumb
breadcrumb:
enable: true
# produce schema for sitelink
sitelink:
enable: true
searchUrl: https://www.webmanajemen.com/search?q={search_term_string}
# produce schema for homepage
homepage:
enable: true
# this function still under development because JAVASCRIPT HEAP MEMORY and my device is 8GB RAM
img:
enable: true
# fix broken images
broken: false
# default broken/missing images
# https://github.com/dimaslanjaka/hexo-seo/blob/pre-release/src/search/index.ts#L53
default: https://upload.wikimedia.org/wikipedia/commons/6/65/No-Image-Placeholder.svg
# broken images methods
# serverside : process broken images from server side (caused javascript heap out of memory, if your post large and your device has insufficient memory)
# clientside : process broken image from client side browser with webjs
onerror: serverside
# external links fix
links:
# enable or false
enable: true
# allowed following links, otherwise nofollow others
exclude:
- webmanajemen.com
- web-manajemen.blogspot.com
# seo-friendly sitemap
# you can fill value `sitemap: true` to create both sitemaps
sitemap:
# auto generate seo friendly sitemap on http://yoursite.com/sitemap.xml
# forked from yoast seo
# location: /sitemap.xml /page-sitemap.xml /post-sitemap.xml /category-sitemap.xml /tag-sitemap.xml
yoast: true
# google news sitemap
# location: /google-news-sitemap.xml
gnews: true
search:
# hexo seo-search page type to index
type: ['page', 'post']
feed:
# hexo seo-feed page type to index
type: [page, post]
# site icon for rss (PNG, JPEG, GIF)
icon: 'https://w7.pngwing.com/pngs/745/306/png-transparent-gallery-image-images-photo-picture-pictures-set-app-incredibles-icon-thumbnail.png'
```
## Generate search data
Generate json data for all published posts or pages (based on `config.seo.search.type`)
> Support generate more than 1k pages on device RAM 8 GB
>
> json data saved on `public_dir/hexo-seo-search.json` and `source_dir/hexo-seo-search.json`
```bash
hexo seo-search
```
Search data result
```jsonc
[
{
"title": "Blockquote Shortcode",
"date": "2023-04-08T15:30:00.691Z",
"updated": "2023-04-08T15:30:00.691Z",
"slug": "blockquote",
"excerpt": "",
"permalink": "http://www.webmanajemen.com/docs/hexo-seo/blockquote.html",
"layout": "post",
"objectID": "54fb9f4665464c46cd47ce1259af43a1",
"date_as_int": 1680967800,
"updated_as_int": 1680967800,
"categories": [
{
"name": "hexo",
"path": "categories/hexo/"
}
],
"tags": [
{
"name": "blockquote",
"path": "tags/blockquote/"
},
{
"name": "shortcode",
"path": "tags/shortcode/"
}
],
"author": "Dimas Lanjaka"
},
// and more data here
]
```
## Generate feeds
Generate RSS 2.0 and ATOM file
```bash
hexo seo-feed
```
Generated file written to
- RSS: `public_dir/rss.xml` and `source_dir/rss.xml`
- ATOM: `public_dir/atom.xml` and `source_dir/atom.xml`
## Site/Post/Page front-matter metadata
This plugin support parsing these customized metadata
### Author
By default hexo author is string with value author name
```yaml
author: Author Name
```
For this plugin, we can put author metadata with more **complex** information. [Reference](https://github.com/dimaslanjaka/hexo-seo/blob/pre-release/src/utils/getAuthor.ts)
```yaml
author:
name: Author Name
link: http://facebook.com/authorUsername
email: [email protected]
```
> This parser supported for site config (**_config.yml**) and post markdown and page markdown.
# Preview
# Issues
- `hexo.on('exit')` not called at end of process
> no more issue [Hexo On Exit Event](https://github.com/hexojs/hexo/issues/4822)
> this plugin already have schedule function
# Troubleshoot
- node_libcurl binding not found
```shell
sudo apt-get install libcurl4-openssl-dev -y
# run below codes only if above package already installed
rm -rf node_modules/node-libcurl
npm install node-libcurl --build-from-source
```
- Fix javascript heap out of memory
```shell
# POSIX
export NODE_OPTIONS=--max_old_space_size=8096
# windows
set NODE_OPTIONS=--max_old_space_size=8096
```
- **important** after you update this plugin, you could cleaning the temp folders with:
```shell
hexo clean # this will cleaning temporarily folders of this plugin
```
# FAQ
- Why search, rss, atom separated to CLI usage ?
> When compiled inside hexo process, these functions will generate new array with same size of all page/post length. This may caused **OUT OF MEMORY HEAP**, specially for device RAM 8 GB **OR** Github Actions (CI) free.
>
> So, the best practice is **separate the process**
# Status
[](https://github.com/dimaslanjaka/hexo-seo/issues?q=is%3Aopen+is%3Aissue+label%3A%22Status%3A+Available%22) [](https://github.com/dimaslanjaka/hexo-seo/labels/Status:%20In%20Progress) [](https://github.com/dimaslanjaka/hexo-seo/labels/Status%3A%20Review%20Needed)
[](https://github.com/dimaslanjaka/hexo-seo/labels/Priority%3A%20Critical) [](https://github.com/dimaslanjaka/hexo-seo/labels/Priority%3A%20High) [](https://github.com/dimaslanjaka/hexo-seo/labels/Priority%3A%20Medium) [](https://github.com/dimaslanjaka/hexo-seo/labels/Priority%3A%20Low)
# Website using Hexo NodeJS Blogging System
[](https://github.com/dimaslanjaka/dimaslanjaka.github.io/actions/workflows/page.yml)
[](https://github.com/dimaslanjaka/dimaslanjaka.github.io/tree/compiler)
[](https://webmanajemen.com)
## hexo-adsense
[](https://badge.fury.io/js/hexo-adsense)
[](https://npmjs.com/package/hexo-adsense)
[](https://npmjs.com/package/hexo-adsense)
## hexo-seo
[](https://badge.fury.io/js/hexo-seo)
[](https://npmjs.com/package/hexo-seo)
[](https://npmjs.com/package/hexo-seo)
## hexo-blogger-xml
[](https://badge.fury.io/js/hexo-blogger-xml)
[](https://npmjs.com/package/hexo-blogger-xml)
[](https://npmjs.com/package/hexo-blogger-xml)
