Lobe SEO is a workflow tool that automates SEO Matter using ChatGPT.
English ・ 简体中文 ・ Changelog · Report Bug · Request Feature
Table of Contents
- [x] 🤖 Automate SEO Matter using ChatGPT
- [x] ♻️ Support incremental SEO updates, automatically adding content for missing SEO information
- [x] 🛠️ Support custom OpenAI models, API proxies, temperature
- [x] 📝 Support
Markdown
Mdx
SEO automation
To install Lobe SEO, run the following command:
npm install -g @lobehub/seo-cli
[!IMPORTANT]
Make sure your environment hasNode.js
version >= 18
To initialize Lobe i8n configuration, run the following command:
$ lobe-seo -o # or use the full flag --option
[!IMPORTANT]
To use AI auto-generation, you need to fill in the OpenAI token in the settings
# Translate Locale files
$ lobe-seo
# Specify a configuration file
$ lobe-seo -c './custom-config.js' # or use the full flag --config
You can choose any configuration method in cosmiconfig format
-
seo
property inpackage.json
-
.seorc
file in JSON or YAML format -
.seorc.json
,.seorc.yaml
,.seorc.yml
,.seorc.js
,.seorc.cjs
files
[!TIP]
This project provides a
defineConfig
secure definition method that can be imported from@lobehub/seo-cli
Some additional configurations are provided in this project, set using environment variables:
Environment Variable | Type | Description | Example |
---|---|---|---|
OPENAI_API_KEY |
Required | This is the API key you obtained from the OpenAI account page | sk-xxxxxx...xxxxxx |
OPENAI_PROXY_URL |
Optional | If you manually configure an OpenAI API proxy, you can use this setting to override the default OpenAI API request base URL |
https://api.chatanywhere.cn/v1 Default: https://api.openai.com/v1
|
Property Name | Required | Type | Default Value | Description |
---|---|---|---|---|
entry | * |
string |
- | Entry file or folder |
entryExtension | string |
.mdx |
Entry file extension | |
groupKey | string |
- | Set group key for SEO matters | |
tagStringify | boolean |
false |
Stringify the tags array | |
modelName | string |
gpt-3.5-turbo |
Model used | |
temperature | number |
0 |
Sampling temperature used | |
reference | string |
- | Provide some rule for more accurate seo | |
concurrency | number |
5 |
Number of concurrently pending promises returned | |
experimental | experimental |
{} |
Experimental features, see below |
Property Name | Required | Type | Default Value | Description |
---|---|---|---|---|
jsonMode | boolean |
false |
Enable GPT forced JSON output for stability improvement (only supported by new models after November 2023) |
const { defineConfig } = require('@lobehub/seo-cli');
module.exports = defineConfig({
entry: './docs/**/*.mdx',
modelName: 'gpt-3.5-turbo-1106',
experimental: {
jsonMode: true,
},
});
{
"entry": "./docs/**/*.mdx",
"experimental": {
"jsonMode": true
},
"modelName": "gpt-3.5-turbo-1106"
}
{
"...": "...",
"seo": {
"entry": "./docs/**/*.mdx",
"modelName": "gpt-3.5-turbo-1106",
"experimental": {
"jsonMode": true
}
}
}
Automatically generate SEO files using the lobe-seo
command:
$ lobe-seo
You can use Github Codespaces for online development:
Alternatively, you can clone the repository and run the following commands for local development:
$ git clone https://github.com/lobehub/lobe-cli-toolbox.git
$ cd lobe-cli-toolbox
$ bun install
$ cd packages/lobe-seo
$ bun dev
We welcome contributions in all forms. If you are interested in contributing code, you can check out our GitHub Issues, showcase your creativity, and share your ideas with us.
- 🤖 Lobe Chat - An open-source, extensible (Function Calling), high-performance chatbot framework. It supports one-click free deployment of your private ChatGPT/LLM web application.
- 🤯 Lobe Theme - The modern theme for stable diffusion webui, exquisite interface design, highly customizable UI, and efficiency boosting features.
- langchainjs - https://github.com/hwchase17/langchainjs
Copyright © 2023 LobeHub.
This project is licensed under MIT.