Code for my personal website

docs: update readme

Changed files
+6 -51
+6 -51
README.md
··· 1 - # Astro Starter Kit: Basics 1 + # Safwan's personal website 2 2 3 - ```sh 4 - npm create astro@latest -- --template basics 5 - ``` 3 + Code for my personal site. The design of the site is heavily inspired from multiple websites and templates, since I'm no designer lol. 4 + This will change soon as I'm working on a full revamp! 6 5 7 - [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) 8 - [![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics) 9 - [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json) 6 + ## Other details 10 7 11 - > ๐Ÿง‘โ€๐Ÿš€ **Seasoned astronaut?** Delete this file. Have fun! 12 - 13 - ![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554) 14 - 15 - ## ๐Ÿš€ Project Structure 16 - 17 - Inside of your Astro project, you'll see the following folders and files: 18 - 19 - ```text 20 - / 21 - โ”œโ”€โ”€ public/ 22 - โ”‚ โ””โ”€โ”€ favicon.svg 23 - โ”œโ”€โ”€ src/ 24 - โ”‚ โ”œโ”€โ”€ components/ 25 - โ”‚ โ”‚ โ””โ”€โ”€ Card.astro 26 - โ”‚ โ”œโ”€โ”€ layouts/ 27 - โ”‚ โ”‚ โ””โ”€โ”€ Layout.astro 28 - โ”‚ โ””โ”€โ”€ pages/ 29 - โ”‚ โ””โ”€โ”€ index.astro 30 - โ””โ”€โ”€ package.json 31 - ``` 32 - 33 - Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. 34 - 35 - There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. 36 - 37 - Any static assets, like images, can be placed in the `public/` directory. 38 - 39 - ## ๐Ÿงž Commands 40 - 41 - All commands are run from the root of the project, from a terminal: 42 - 43 - | Command | Action | 44 - | :------------------------ | :----------------------------------------------- | 45 - | `npm install` | Installs dependencies | 46 - | `npm run dev` | Starts local dev server at `localhost:4321` | 47 - | `npm run build` | Build your production site to `./dist/` | 48 - | `npm run preview` | Preview your build locally, before deploying | 49 - | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | 50 - | `npm run astro -- --help` | Get help using the Astro CLI | 51 - 52 - ## ๐Ÿ‘€ Want to learn more? 53 - 54 - Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). 8 + - Built using Astro and Tailwind (no extra frameworks used as of now) 9 + - Blog and project posts published through a self-hosted Ghost CMS instance