From dccde74dc0dba105f5ed5b4709ef0d8e695964a3 Mon Sep 17 00:00:00 2001 From: Sat Naing Date: Thu, 29 Sep 2022 11:31:54 +0630 Subject: [PATCH] Remove unused comments --- .../how-to-configure-astropaper-theme.md | 24 +++++++------------ 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/src/contents/how-to-configure-astropaper-theme.md b/src/contents/how-to-configure-astropaper-theme.md index ceacc29..392a7ef 100644 --- a/src/contents/how-to-configure-astropaper-theme.md +++ b/src/contents/how-to-configure-astropaper-theme.md @@ -35,19 +35,17 @@ export const SITE = { }; ``` - - Here are SITE configuration options -| Options | Description | -| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `website` | Your deployed website url | -| `author` | Your name | -| `desc` | Your site description. Useful for SEO and social media sharing. | -| `title` | Your site name | -| `ogImage` | Your default OG image for the site. Useful for social media sharing. OG image can be updated under `/public` directory. | -| `lightAndDarkMode` | Enable or disable `light & dark mode` for the website. If disabled, primary color scheme will be used. This option is enabled by default. | -| `postPerPage` | You can specify how many posts will be displayed in each posts page. (eg: you you specify SITE.postPerPage to 3, page 1, page 2 etc will only show 3 posts per page) | +| Options | Description | +| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `website` | Your deployed website url | +| `author` | Your name | +| `desc` | Your site description. Useful for SEO and social media sharing. | +| `title` | Your site name | +| `ogImage` | Your default OG image for the site. Useful for social media sharing. OG image can be updated under `/public` directory. | +| `lightAndDarkMode` | Enable or disable `light & dark mode` for the website. If disabled, primary color scheme will be used. This option is enabled by default. | +| `postPerPage` | You can specify how many posts will be displayed in each posts page. (eg: you you specify SITE.postPerPage to 3, page 1, page 2 etc will only show 3 posts per page) | ## Configuring logo or title @@ -65,8 +63,6 @@ export const LOGO_IMAGE = { }; ``` - - If you specify `LOGO_IMAGE.enable` => `false`, AstroPaper will automatically convert `SITE.title` to the main site text logo. If you specify `LOGO_IMAGE.enable` => `true`, AstroPaper will use the logo image as the site's main logo. @@ -109,8 +105,6 @@ export const SOCIALS: SocialsObject = [ ] ``` - - You have to set specific social link to `active: true` in order to appear your social links in hero and footer section. Then, you also have to specify your social link in `href` property. For instance, if I want to make my Github appear, I'll make it like this.