Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-23 21:53:55 -05:00
Code Issues Activity
astro/examples/blog/README.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

66 lines
2.4 KiB
Markdown
Raw Normal View History

cleanup docs changes
2021-09-06 03:31:10 -05:00
# Astro Starter Kit: Blog
update example readmes (#591) * update example readmes * Update README.md
2021-07-01 07:43:25 -05:00
cleanup docs changes
2021-09-06 03:31:10 -05:00
```
.md only: npm init astro --> npm create astro (#4760) * .md only: npm init astro --> npm create astro For consistency with https://github.com/withastro/docs/pull/360. Docs always use `npm create astro` (never `npm init astro`), README.md files in this repo should do the same. Search: `\b(npm|yarn|pnpm) init astro\b` Replace: `$1 create astro` Except for two instances: 1. `packages/create-astro/CHANGELOG.md` -- skipped because changelog. 2. `packages/create-astro/test/create-astro.test.js.skipped` -- skipped, old test disabled in https://github.com/withastro/astro/pull/3168. * docs: add `@latest` to `npm create astro` Co-authored-by: Bjorn Lu <bjorn@bjornlu.com> Co-authored-by: Michael Rienstra <michael@goodmoney.com>
2022-09-16 12:40:06 -05:00
npm create astro@latest -- --template blog
cleanup docs changes
2021-09-06 03:31:10 -05:00
```
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
update repo URL (#1994)
2021-11-23 17:47:05 -05:00
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
Add “Open with CodeSandbox” buttons to example project READMEs (#5322) Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-11-10 05:32:13 -05:00
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/s/github/withastro/astro/tree/latest/examples/blog)
update examples for stackblitz (#1379)
2021-09-16 10:06:22 -05:00
cleanup docs changes
2021-09-06 03:31:10 -05:00
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
redesign create-astro (#301) * redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2021-06-08 10:10:56 -05:00
feat: add screenshots to official theme readme files (#4442) * feat: add screenshot to basic example * feat: add screenshot to blog examples * feat: add screenshots to docs example * feat: add screenshot to portfolio example
2022-08-24 09:01:01 -05:00
![blog](https://user-images.githubusercontent.com/4677417/186189140-4ef17aac-c3c9-4918-a8c2-ce86ba1bb394.png)
Improve blog template (#217)
2021-05-17 17:45:41 -05:00
Features:
Update: blog template (#4283) * add new blog template * update placeholder images * use svg favicon * Update examples/blog/src/pages/blog/using-mdx.mdx Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * fred pass * more fred pass Co-authored-by: Nate Moore <nate@astro.build> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-13 02:09:40 -05:00
- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
image fix (#4322)
2022-08-14 23:26:33 -05:00
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
Improve blog template (#217)
2021-05-17 17:45:41 -05:00
redesign create-astro (#301) * redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2021-06-08 10:10:56 -05:00
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
cleanup docs changes
2021-09-06 03:31:10 -05:00
```
Update: blog template (#4283) * add new blog template * update placeholder images * use svg favicon * Update examples/blog/src/pages/blog/using-mdx.mdx Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * fred pass * more fred pass Co-authored-by: Nate Moore <nate@astro.build> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-13 02:09:40 -05:00
├── public/
├── src/
│   ├── components/
│   ├── layouts/
│   └── pages/
Example blog rework (#3896) * refactor: restructure components, kill dead code * nit: tweak base styles * nit: remove unneeded code comments * refactor: replace unused permalink with canonicalURL * refactor: add missing prop types * feat: make markdown examples more interesting * chore: consistent semis and quotes * chore: astro check failures * fix: bad url prop * fix: bad frontmatter quote * chore: more dead styles * chore: add header gap * refactor: use tsx for likebutton * fix: restore post sorting * chore: remove unused flex-row util * fix: small md formatting on README * chore: run through astro-plugin-prettier * fix: revert to double quotes * fix: manually move style outside <body> * fix: update file tree in README * refactor: publish-date -> time * refactor: remove unused div and margin * refactor: publishDate -> time on layout * refactor: .heroImage -> img * refactor: .logo -> svg * feat: update social image, remove jpg * fix: remove prism stylesheet!
2022-07-12 11:17:36 -05:00
├── astro.config.mjs
├── README.md
├── package.json
Update README.md (#3597) - Fix the tree to reflect the actual example contents - Remove RSS and Sitemap bullet points, since they aren't in the project
2022-06-15 10:32:40 -05:00
└── tsconfig.json
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
```
cleanup docs changes
2021-09-06 03:31:10 -05:00
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
cleanup docs changes
2021-09-06 03:31:10 -05:00
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
cleanup docs changes
2021-09-06 03:31:10 -05:00
Any static assets, like images, can be placed in the `public/` directory.
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
redesign create-astro (#301) * redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2021-06-08 10:10:56 -05:00
## 🧞 Commands
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
redesign create-astro (#301) * redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2021-06-08 10:10:56 -05:00
All commands are run from the root of the project, from a terminal:
update example scripts (#4098)
2022-08-05 23:36:23 -05:00
| Command | Action |
| :--------------------- | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `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 |
redesign create-astro (#301) * redesign create astro * add changeset * Use npm start * Update the astro version * Adds the changeset Co-authored-by: Fred Schott <fks@Freds-MBP.attlocal.net> Co-authored-by: Matthew Phillips <matthew@skypack.dev>
2021-06-08 10:10:56 -05:00
## 👀 Want to learn more?
Improve Tailwind docs & Tailwind support (#92)
2021-04-14 11:36:00 -05:00
Update: blog template (#4283) * add new blog template * update placeholder images * use svg favicon * Update examples/blog/src/pages/blog/using-mdx.mdx Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> * fred pass * more fred pass Co-authored-by: Nate Moore <nate@astro.build> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
2022-08-13 02:09:40 -05:00
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
## Credit
feat: add screenshots to official theme readme files (#4442) * feat: add screenshot to basic example * feat: add screenshot to blog examples * feat: add screenshots to docs example * feat: add screenshot to portfolio example
2022-08-24 09:01:01 -05:00
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
Reference in a new issue Copy permalink