Add some content to the readme file
This commit is contained in:
33
README-CN.MD
33
README-CN.MD
@@ -67,16 +67,20 @@ npm run newpost
|
|||||||
> node ./scripts/newpost.mjs
|
> node ./scripts/newpost.mjs
|
||||||
|
|
||||||
? What's the title?
|
? What's the title?
|
||||||
// 必选,在这里输入你的文章标题。
|
// 必选,在这里输入你的文章标题。建议不超过 20 字。
|
||||||
|
|
||||||
? What's the subtitle?
|
? What's the subtitle?
|
||||||
// 可选。在这里输入你的文章副标题。
|
// 可选。在这里输入你的文章副标题。建议不超过 20 字。
|
||||||
|
|
||||||
? Assign tags for the posts and separate them with commas.
|
? Assign tags for the posts and separate them with commas.
|
||||||
// 可选。为文章打上标签,并且用英文逗号来分隔它们,比如technology,news,programming
|
// 可选。为文章打上标签,并且用英文逗号来分隔它们。
|
||||||
|
// 比如technology,news,programming 。
|
||||||
|
// 建议标签数量不超过 4 个,每个标签不超过 3 个单词或者 5 个汉字。
|
||||||
|
|
||||||
? Do NOT prompt this post? (D:false) No
|
? Do NOT prompt this post? (D:false) No
|
||||||
// 默认为否。是否要低调发布?如果是,那么这篇文章发布后不会被推送到首页,也不会收录到 RSS ,只能通过文章总列表中找到它。
|
// 默认为否。是否要低调发布?
|
||||||
|
// 如果是,那么这篇文章发布后不会被推送到首页,也不会收录到 RSS 。
|
||||||
|
// 只能通过文章总列表中找到它。
|
||||||
|
|
||||||
? Do you want to pin this post? (D:false) No
|
? Do you want to pin this post? (D:false) No
|
||||||
// 默认为否。是否要置顶这篇文章?
|
// 默认为否。是否要置顶这篇文章?
|
||||||
@@ -93,6 +97,27 @@ Open the file ./data/posts/2023-12-24-This-is-my-new-post.md to write your blog
|
|||||||
Some fields, such as summary, need to be filled in by yourself after opening the file.
|
Some fields, such as summary, need to be filled in by yourself after opening the file.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
打开刚创建好的帖子文件,你可以看到如下信息:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
---
|
||||||
|
title: "xxxxxxx"
|
||||||
|
subtitle: "xxxxxxx"
|
||||||
|
summary: ""
|
||||||
|
coverURL: ""
|
||||||
|
time: "2023-12-29"
|
||||||
|
tags: ["xxx","xxx"]
|
||||||
|
noPrompt: false
|
||||||
|
pin: false
|
||||||
|
allowShare: true
|
||||||
|
---
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
其中 `title` ,`subtitle` ,`tags` 等等字段在创建时脚本已经自动为你生成好了。只有 `summary` ,`coverURL` 字段还是空的。它们需要你手动填写。
|
||||||
|
|
||||||
|
`summary` 字段是对文章的大体总结,会展示到博客列表中,建议 100 字以内。而 `coverURL` 是博客的封面图片,需要写入图片的网络引用链接,会展示到帖子顶部。为了最佳展示效果,建议图片的长宽比为 5 : 2。
|
||||||
|
|
||||||
#### 开发
|
#### 开发
|
||||||
|
|
||||||
在开发环境下执行项目。
|
在开发环境下执行项目。
|
||||||
|
|||||||
32
README.MD
32
README.MD
@@ -68,15 +68,22 @@ Then, the program will ask you a series of questions. Simply input your answers
|
|||||||
|
|
||||||
? What's the title?
|
? What's the title?
|
||||||
// Required. Enter the title of your article here.
|
// Required. Enter the title of your article here.
|
||||||
|
// Recommended no more than 15 words.
|
||||||
|
|
||||||
? What's the subtitle?
|
? What's the subtitle?
|
||||||
// Optional. Enter the subtitle of your article here.
|
// Optional. Enter the subtitle of your article here.
|
||||||
|
// Recommended no more than 15 words.
|
||||||
|
|
||||||
? Assign tags for the posts and separate them with commas.
|
? Assign tags for the posts and separate them with commas.
|
||||||
// Optional. Tag your article and separate the tags with commas, e.g., technology,news,programming
|
// Optional. Tag your article and separate the tags with commas.
|
||||||
|
// E.g., technology,news,programming
|
||||||
|
// It is recommended that the number of tags should not exceed 4,
|
||||||
|
// and each tag should be no more than 2 words.
|
||||||
|
|
||||||
? Do NOT prompt this post? (D:false) No
|
? Do NOT prompt this post? (D:false) No
|
||||||
// Default is no. Do you want to publish this post discreetly? If yes, then the article won't be pushed to the homepage or included in RSS after publishing, and can only be found in the complete article list.
|
// Default is no. Do you want to publish this post discreetly?
|
||||||
|
// If yes, then the article won't be pushed to the homepage or included in RSS after publishing,
|
||||||
|
// and can only be found in the complete article list.
|
||||||
|
|
||||||
? Do you want to pin this post? (D:false) No
|
? Do you want to pin this post? (D:false) No
|
||||||
// Default is no. Do you want to pin this article?
|
// Default is no. Do you want to pin this article?
|
||||||
@@ -93,6 +100,27 @@ Open the file ./data/posts/2023-12-24-This-is-my-new-post.md to write your blog
|
|||||||
Some fields, such as summary, need to be filled in by yourself after opening the file.
|
Some fields, such as summary, need to be filled in by yourself after opening the file.
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Open the post file you just created and you can see the following content:
|
||||||
|
|
||||||
|
```plaintext
|
||||||
|
---
|
||||||
|
title: "xxxxxxx"
|
||||||
|
subtitle: "xxxxxxx"
|
||||||
|
summary: ""
|
||||||
|
coverURL: ""
|
||||||
|
time: "2023-12-29"
|
||||||
|
tags: ["xxx","xxx"]
|
||||||
|
noPrompt: false
|
||||||
|
pin: false
|
||||||
|
allowShare: true
|
||||||
|
---
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
The existing `title`, `subtitle`, `tags` and other fields are automatically generated for you by the script when you create them. Only `summary` and `coverURL` fields are still empty. They require you to fill them in manually.
|
||||||
|
|
||||||
|
The `summary` field is a general summary of the article, which will be displayed in the blog list. It is recommended to be within 50 words. And `coverURL` is the cover image of the blog. The network reference link of the image needs to be written, which will be displayed at the top of the post. For optimal presentation, the recommended image aspect ratio is 5:2.
|
||||||
|
|
||||||
#### Development
|
#### Development
|
||||||
|
|
||||||
Run the project in development mode.
|
Run the project in development mode.
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ export const Config: TConfig = {
|
|||||||
// Your domain for website.
|
// Your domain for website.
|
||||||
SiteDomain: "nextjs-lexical-blog-demo.vercel.app",
|
SiteDomain: "nextjs-lexical-blog-demo.vercel.app",
|
||||||
|
|
||||||
|
// For the cover image displayed on the homepage, the recommended image aspect ratio is 4:1.
|
||||||
PageCovers: {
|
PageCovers: {
|
||||||
websiteCoverURL: "/images/cover.webp",
|
websiteCoverURL: "/images/cover.webp",
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user