From b1a4f55e12329141084139f224114165312c5d6d Mon Sep 17 00:00:00 2001 From: Manuel Ernesto Garcia <53962116+manuelernestog@users.noreply.github.com> Date: Tue, 4 Oct 2022 23:42:20 -0400 Subject: [PATCH] Updating readme file for deploy details --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e037b54..07acce8 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Once the packages are installed you are ready to run astro. Astro comes with a b npm run dev ``` -### Tech Stack +## Tech Stack - [Astro](astro.build) - [tailwindcss](https://tailwindcss.com/) @@ -70,13 +70,13 @@ npm run dev └── tsconfig.json ``` -### Components usage +## Components usage -#### Layout Components +### Layout Components The `BaseHead`, `Footer`, `Header` and `SideBar` components are already included in the layout sistem. To change the website content you can edit the content of this componenets. -##### SideBar +#### SideBar In the Sidebar you can change the links to all your website pages. @@ -84,7 +84,7 @@ You can change your avatar shape using [mask classes](https://daisyui.com/compon The used social-icons are SVG form [BoxIcons](https://boxicons.com/) pack. -#### TimeLine +### TimeLine The timeline components are used to conform the CV. @@ -99,7 +99,7 @@ The timeline components are used to conform the CV. ``` -#### Card & HorizontalCard +### Card & HorizontalCard ``` html ` tag in `BaseLayout.astro` file. You can chose among 30 themes available or create your custom theme. See themes available [here](https://daisyui.com/docs/themes/). -### Deploy +## Deploy + +You can deploy your site on your favorite static hosting service such as Vercel, Netlify, GitHub Pages, etc. The configuration for the deployment varies depending on the platform where you are going to do it. See the [official Astro information](https://docs.astro.build/en/guides/deploy/) to deploy your website. +> **⚠️ CAUTION**
+> The Blog pagination of this template is implemented using dynamic route parameters in its filename and for now this format is incompatible with SSR deploy configs, so please use the static deploy options for your deployments. + +## Contributing + +Suggestions and pull requests are welcomed! Feel free to open a discussion, an issue or create a pull request. + +## License + +Astro Modern Personal Website is licensed under the MIT license — see the [LICENSE](https://github.com/manuelernestog/astro-modern-personal-website/blob/main/LICENSE) file for details.