Commit graph

28 commits

Author SHA1 Message Date
Laurent Thiebault
0c82e08cec
docs: add the right npm command regarding astro --help for examples' README.md files (#6864) 2023-04-18 08:02:40 +02:00
Brian McManus
48b54d92ea
Fixes example README links to open in codespaces (#6346) 2023-02-23 11:20:19 -06:00
Brian McManus
7da05febea
Enhanced Astro codespace support (#6288)
* Enhanced Astro codespace support

Enhances the base devcontainer and Dockerfile to provide a smoother
development experience out of the box for contributors.

Adds a devcontainer per example so that we can add buttons on astro.new
that will launch users straight into the appropriate example app.

* Cleanup devcontainers and pin base image

* Update .devcontainer/example-welcome-message.txt

Co-authored-by: Samruddhi Khandale <skhandale@microsoft.com>

---------

Co-authored-by: Samruddhi Khandale <skhandale@microsoft.com>
2023-02-23 09:34:37 -06:00
Obinna Ekwuno
db2c59fc18
Update open with codesandbox link to use synced sandboxes (#6105) 2023-02-03 11:52:11 -06:00
Ben Holmes
7d72aeeae8
Migrate blog and docs starters to content collections (#5858)
* docs: update README for `content/`

* chore: update env

* feat: update blog to use content collections

* chore: remove with-content starter

* fix: single quotes -> double

* feat: update docs starter to content collections

* refactor: config -> consts

* chore: import type

* edit: Astro will -> Use

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>

* chore: remove unused null check

* nit: spacing

* nit: `as Props` 1

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>

* nit: `as Props` 2

Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>

* chore: consistent CONSTS usage

* chore: `type` imports at top

* chore: consistent quote usage on YAML

* chore: remove `as Props` from docs

Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
2023-01-18 08:43:58 -05:00
Obinna Ekwuno
8cdd5aabdb
Add “Open with CodeSandbox” buttons to example project READMEs (#5322)
Co-authored-by: Chris Swithinbank <swithinbank@gmail.com>
2022-11-10 11:32:13 +01:00
Michael Rienstra
a800bf7ec1
.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
Moritz Stückler
c960f602da
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 10:01:01 -04:00
Fred K. Schott
0e2f4d74b7
image fix (#4322) 2022-08-15 00:26:33 -04:00
Fred K. Schott
d54588c7a4
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 00:09:40 -07:00
Fred K. Schott
3f3a293b6b
update example scripts (#4098) 2022-08-05 21:36:23 -07:00
Ben Holmes
ab232dd10f
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 12:17:36 -04:00
Dan Jutan
8ed924d2ed
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
Sarah Rainsberger
842ed555d9
Correcting the link to docs on Just the Basics starter README (#3482)
* Correcting the link to docs on Just the Basics starter README

The link to documentation did not actually go to Docs. Now it does!

* fixing all other starter template READMEs with incorrect link to docs
2022-05-31 10:11:49 -04:00
Fred K. Schott
7476a92461
update repo URL (#1994) 2021-11-23 14:47:05 -08:00
Okiki
eb4effb6b7
docs: seperate npm run build and npm run dev to avoid confusion (#1798)
To avoid confusion I seperated the  `npm run build` and the `npm run dev` commands, beginners might get confused by each command being listed in the same list, thinking they need to run `npm run build` before Astro works properly.

Add `npm run preview` commands to all examples where they are missing
2021-11-11 13:28:51 -06:00
Fred K. Schott
cb7a957f41
update examples for stackblitz (#1379) 2021-09-16 08:06:22 -07:00
Fred K. Schott
9f06fb014b cleanup docs changes 2021-09-06 01:31:10 -07:00
aFuzzyBear
d321d8366b Adds examples page 2021-09-06 01:21:39 -07:00
Jonathan Neal
e66872125d
add dev script, switch documentation from advising start to dev script (#1141) 2021-08-18 22:07:08 -07:00
Kyosuke
5fcd466d95
replace npm run start with npm start (#791) 2021-07-21 07:09:44 -07:00
Caleb Jasik
8eeb6b4fe8
Docs: npm@7 requires an extra -- for arguments passed to the command, per @natemoo-re's description. (#786) 2021-07-20 20:06:11 -05:00
Fred K. Schott
67ef02534f
update example readmes (#591)
* update example readmes

* Update README.md
2021-07-01 08:43:25 -04:00
Fred K. Schott
bad8b32df7 update discord link 2021-06-08 14:00:13 -07:00
Fred K. Schott
6bca7c83a7
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 11:10:56 -04:00
Drew Powers
d6cedac38e
Improve blog template (#217) 2021-05-17 17:45:41 -05:00
Nate Moore
dea1a6dfc9
Update defaults directory structure to src and dist (#132)
* chore: update defaults in docs

* chore: update config defaults

* test: update tests to config defaults

* chore: update gitignore to new defaults

* docs: update readme to new defaults

* chore: update examples to new defaults

* chore: update default exclude in lang server

* chore: update tests

* test: fix failing tests

* chore: update www defaults
2021-04-26 15:54:20 -06:00
Drew Powers
ec75312a15
Improve Tailwind docs & Tailwind support (#92) 2021-04-14 10:36:00 -06:00