Commit graph

25 commits

Author SHA1 Message Date
kalana kithmina
da0cfebe64
fix typo (#6584)
* fix typo 

fix error: didn't match with base path code with readme guide

* Fix related typos

---------

Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>
2023-03-19 22:19:17 -03: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
Rychart Redwerkz
9bb0bfab13
Fix edit this Page on examples/docs (#6028)
* 🐛 Fix path from `pages` to `content/docs`

* 🐛 Fix path from `pages` to `content/docs`
2023-01-30 09:48:57 -05:00
Nick McCurdy
d47a9075bf
Make examples more consistent (#5201)
* Don't ignore `.output`

From packages/integrations/vercel/CHANGELOG.md#minor-changes-5:

> The output folder changed from `.output` to `.vercel/output` — you may need to update your `.gitignore`.

* Make example readmes more consistent

* remove `astro check` command

Co-authored-by: Nate Moore <nate@astro.build>
2023-01-26 08:37:30 -06:00
Anders Kaseorg
53e0c98dae
Fix spelling mistakes found by codespell and mwic (#5627) 2022-12-19 12:00:00 +01: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
Brendan O'Leary
80ae62ad99
Fix theme.css location in docs starter project (#4697)
* Fix theme.css location in docs starter project

* Also fix in diff display

Co-authored-by: Brendan O'Leary <boleary@gitlab.com>
2022-09-09 12:19:45 -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
3f3a293b6b
update example scripts (#4098) 2022-08-05 21:36:23 -07: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
Rafid Muhymin Wafi
336eaa777b
Fixed MD Lint issues (#3038) 2022-04-10 18:59:27 -03:00
Jang Rush
1f45d23103
describe how to use non-en lang in doc theme (#2447) 2022-01-24 10:32:27 -05:00
Fred K. Schott
7476a92461
update repo URL (#1994) 2021-11-23 14:47:05 -08:00
Jonathan Neal
1692675575
Doc improvements (#1929)
* Update astro & markdown code blocks for consistency

* Add 'JSX in Frontmatter' note to Migration Guide
2021-11-19 14:53:38 -05: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
AsyncBanana
3cd1c2020b
Added frontmatter example to docs example (#1567) 2021-10-18 13:35:16 -05:00
Fred K. Schott
cb7a957f41
update examples for stackblitz (#1379) 2021-09-16 08:06:22 -07:00
Fred K. Schott
2e8db7ad23 add algolia and cleanup docs readme 2021-08-26 15:03:21 -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