Add new article for configuring astro-paper theme

2026-08-14 11:29:33 +08:00 · 2022-09-23 13:32:01 +06:30
parent ef1fac6043
commit 33654ade7f
1 changed files with 83 additions and 0 deletions
@@ -0,0 +1,83 @@
+---
+author: Sat Naing
+datetime: 2022-09-23T04:58:53Z
+title: How to configure AstroPaper theme
+slug: how-to-configure-astropaper-theme
+featured: true
+draft: false
+tags:
+  - configuration
+  - docs
+ogImage: ""
+description: How you can make AstroPaper theme absolutely yours.
+---
+
+AstroPaper is a highly customizable Astro blog theme. With AstroPaper, you can customize everything according to your personal taste. This article will explain how you can make some customizations easily in the config file.
+
+## Table of contents
+
+## Configuring SITE
+
+First of all, replace site property of _`astro.config.mjs` file with your own deployed domain. (You can omit this step if you don't have deployed domain yet or you are still in development mode)_
+
+Another important configurations lies in `src/config.ts` file. Within that file, you'll see the `SITE` object where you can specify your website's main configurations.
+
+![](https://res.cloudinary.com/noezectz/v1663912719/astro-paper/site-config_kw89jo.png)
+
+Here are SITE configuration options
+
+- 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.
+- 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)
+
+## Configure logo or title
+
+You can specify site's title or logo image in `src/config.ts` file.
+
+![](https://res.cloudinary.com/noezectz/v1663911318/astro-paper/AstroPaper-logo-config_goff5l.png)
+
+![](https://res.cloudinary.com/noezectz/v1663912849/astro-paper/logo-image-config_q7d574.png)
+
+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.
+
+You have to specify `logo.png` or `logo.svg` under `/public/assets` directory. Currently, only svg and png image file formats are supported. (**_Important!_** _logo name has to be logo.png or logo.svg)_
+
+If your logo image is png file format, you have to set `LOGO_IMAGE.svg` => `false`.
+
+It is recommended that you specify width and height of your logo image. You can do that by setting `LOGO_IMAGE.width` _and_ `LOGO_IMAGE.height`
+
+## Configure social links
+
+You can configure your own social links along with its icons.
+
+![](https://res.cloudinary.com/noezectz/v1663914759/astro-paper/astro-paper-socials_tkcjgq.png)
+
+Currently 19 social icons are supported. (Github, LinkedIn, Facebook etc.)
+
+You can specify and enable certain social links in hero section and footer. To do this, go to `/src/config.ts` and then you'll find `SOCIALS` object.
+
+![](https://res.cloudinary.com/noezectz/v1663915122/astro-paper/SOCIALS-config_tkwhqw.png)
+
+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.
+
+```js
+export const SOCIALS: SocialsObject = [
+  {
+    name: "Github",
+    href: "https://github.com/satnaing",
+    active: true,
+  }
+  ...
+]
+```
+
+## Conclusion
+
+This is the brief specification of how you can customize this theme. You can customize more if you know some coding. For customizing styles, please read this article. Thanks for reading.✌🏻