-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Juankimr
authored and
Juankimr
committed
Nov 30, 2024
1 parent
074ee26
commit ea7988d
Showing
1 changed file
with
16 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,21 @@ | ||
| # Astro Starter Kit: Blog | ||
| # Welcome to my **Tech Blog**! | ||
| Here, I share my thoughts, discoveries, and learnings related to technology, programming (especially Python), | ||
| and a variety of other tech-related topics. | ||
|
|
||
| ```sh | ||
| npm create astro@latest -- --template blog | ||
| ``` | ||
| ## Blog Topics | ||
|
|
||
| [](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog) | ||
| [](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog) | ||
| [](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json) | ||
| - **TIL (Today I Learned)**: A collection of bite-sized, everyday programming tips and tricks I’ve learned along the way. | ||
| - <mark>**Python**</mark>: Deep dives into Python, from beginner tips to advanced programming concepts. | ||
| - **Web Development**: Thoughts on web technologies, from frontend frameworks to backend systems. | ||
|
|
||
| > 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! | ||
| --- | ||
| This blog is built using **Astro**, a modern static site generator that delivers fast and optimized web experiences. | ||
|
|
||
|  | ||
| #### Astro blog Features | ||
|
|
||
| Features: | ||
|
|
||
| - ✅ Minimal styling (make it your own!) | ||
| - ✅ 100/100 Lighthouse performance | ||
| - ✅ SEO-friendly with canonical URLs and OpenGraph data | ||
| - ✅ Sitemap support | ||
| - ✅ RSS Feed support | ||
| - ✅ Markdown & MDX support | ||
|
|
||
| ## 🚀 Project Structure | ||
|
|
||
| Inside of your Astro project, you'll see the following folders and files: | ||
|
|
||
| ```text | ||
| ├── public/ | ||
| ├── src/ | ||
| │ ├── components/ | ||
| │ ├── content/ | ||
| │ ├── layouts/ | ||
| │ └── pages/ | ||
| ├── astro.config.mjs | ||
| ├── README.md | ||
| ├── package.json | ||
| └── tsconfig.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. | ||
|
|
||
| The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more. | ||
|
|
||
| Any static assets, like images, can be placed in the `public/` directory. | ||
|
|
||
| ## 🧞 Commands | ||
|
|
||
| All commands are run from the root of the project, from a terminal: | ||
|
|
||
| | Command | Action | | ||
| | :------------------------ | :----------------------------------------------- | | ||
| | `npm install` | Installs dependencies | | ||
| | `npm run dev` | Starts local dev server at `localhost:4321` | | ||
| | `npm run build` | Build your production site to `./dist/` | | ||
| | `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? | ||
|
|
||
| Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). | ||
|
|
||
| ## Credit | ||
|
|
||
| This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/). | ||
| - **Fast and Optimized**: Powered by Astro for lightning-fast performance and optimized builds. | ||
| - **Markdown Posts**: Write blog posts easily in Markdown format. | ||
| - **Reusable Components**: Modular components for easy maintenance and scalability. | ||
| - **SEO-friendly**: Built with SEO best practices to make sure your posts reach the right audience. | ||
| - **Clean and Modern Design**: Simple and responsive design for a better user experience. | ||
| - **Static Site Generation**: Fully static and secure, with pre-built HTML for improved speed. |