Skip to content

Commit c9989ef

Browse files
satnaingsatnaing
committed
docs: update site config docs for editPost
1 parent cba8879 commit c9989ef

File tree

1 file changed

+17
-11
lines changed

1 file changed

+17
-11
lines changed

‎src/content/blog/how-to-configure-astropaper-theme.md‎

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,22 +33,28 @@ export const SITE = {
3333
lightAndDarkMode: true,
3434
postPerPage: 3,
3535
scheduledPostMargin: 15 * 60 * 1000, // 15 minutes
36+
editPost: {
37+
url: "https://github.com/satnaing/astro-paper/edit/main/src/content/blog",
38+
text: "Suggest Changes",
39+
appendFilePath: true,
40+
},
3641
};
3742
```
3843

3944
Here are SITE configuration options
4045

41-
| Options | Description |
42-
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
43-
| `website` | Your deployed website url |
44-
| `author` | Your name |
45-
| `desc` | Your site description. Useful for SEO and social media sharing. |
46-
| `title` | Your site name |
47-
| `ogImage` | Your default OG image for the site. Useful for social media sharing. OG images can be an external image url or they can be placed under `/public` directory. |
48-
| `lightAndDarkMode` | Enable or disable `light & dark mode` for the website. If disabled, primary color scheme will be used. This option is enabled by default. |
49-
| `postPerIndex` | The number of posts to be displayed at the home page under `Recent` section. |
50-
| `postPerPage` | You can specify how many posts will be displayed in each posts page. (eg: if you set SITE.postPerPage to 3, each page will only show 3 posts per page) |
51-
| `scheduledPostMargin` | In Production mode, posts with a future `pubDatetime` will not be visible. However, if a post's `pubDatetime` is within the next 15 minutes, it will be visible. You can set `scheduledPostMargin` if you don't like the default 15 minutes margin. |
46+
| Options | Description |
47+
| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
48+
| `website` | Your deployed website url |
49+
| `author` | Your name |
50+
| `desc` | Your site description. Useful for SEO and social media sharing. |
51+
| `title` | Your site name |
52+
| `ogImage` | Your default OG image for the site. Useful for social media sharing. OG images can be an external image url or they can be placed under `/public` directory. |
53+
| `lightAndDarkMode` | Enable or disable `light & dark mode` for the website. If disabled, primary color scheme will be used. This option is enabled by default. |
54+
| `postPerIndex` | The number of posts to be displayed at the home page under `Recent` section. |
55+
| `postPerPage` | You can specify how many posts will be displayed in each posts page. (eg: if you set SITE.postPerPage to 3, each page will only show 3 posts per page) |
56+
| `scheduledPostMargin` | In Production mode, posts with a future `pubDatetime` will not be visible. However, if a post's `pubDatetime` is within the next 15 minutes, it will be visible. You can set `scheduledPostMargin` if you don't like the default 15 minutes margin. |
57+
| `editPost` | This option allows users to suggest changes to a blog post by providing an edit link under blog post titles. This feature can be disabled by removing it from the `SITE` config. You can also set `appendFilePath` to `true` to automatically append the file path of the post to the url, directing users to the specific post they wish to edit. |
5258

5359
## Configuring locale
5460

0 commit comments

Comments
 (0)