diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 25 insertions, 19 deletions
@@ -1,28 +1,32 @@ -# Astro Starter Kit: Basics +# Astrolink: Template to share about yourself ```sh -npm create astro@latest -- --template basics +git clone https://github.com/alamguardin/Astrolink.git ``` -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + - +## 🚀 How to change the content? -## 🚀 Project Structure - -Inside of your Astro project, you'll see the following folders and files: +To change the content of the templates, simply locate the ```user.json``` file inside the data folder. You can change the name, profession, and the links you want. ```text / ├── public/ │ └── favicon.svg ├── src/ +│ ├── assets/ +│ │ └── screenshot-app.png +│ │ └── user-profile-image.png │ ├── components/ -│ │ └── Card.astro +│ │ └── icons/ +│ │ └── Link.astro +│ │ └── List.astro +│ │ └── Profile.astro +│ │ └── Shadow.astro +│ ├── data/ +│ │ └── user.json │ ├── layouts/ │ │ └── Layout.astro │ └── pages/ @@ -30,11 +34,17 @@ Inside of your Astro project, you'll see the following folders and files: └── package.json ``` -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. - -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. +Oh, you also have a list of icons that you can use for your links by simply putting the name in the ```icon``` key of each link. -Any static assets, like images, can be placed in the `public/` directory. +- ```dribbble``` +- ```facebook``` +- ```instagram``` +- ```linkedin``` +- ```shop``` +- ```twitch``` +- ```url``` +- ```xtwitter``` +- ```youtube``` ## 🧞 Commands @@ -48,7 +58,3 @@ All commands are run from the root of the project, from a terminal: | `npm run preview` | Preview your build locally, before deploying | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | `npm run astro -- --help` | Get help using the Astro CLI | - -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |