Skip to content

Commit aa78f8e

Browse files
docs: README for Juno
1 parent 9750a99 commit aa78f8e

File tree

2 files changed

+17
-53
lines changed

2 files changed

+17
-53
lines changed

templates/website/astro/README.md

+17-53
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,32 @@
1-
# Astro Starter Kit: Blog
1+
# Juno: Astro Starter Kit
22

33
```sh
4-
npm create astro@latest -- --template blog
4+
npm create juno@latest -- --template astro
55
```
66

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/blog)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/blog)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/blog/devcontainer.json)
7+
> 🧑‍🚀 **Seasoned dev?** Delete this file. Have fun!
108
11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
9+
![A screenshot of the starter kit](./screenshot.png)
1210

13-
![blog](https://github.com/withastro/astro/assets/2244813/ff10799f-a816-4703-b967-c78997e8323d)
11+
A starter kit developer for [Juno](https://juno.build) using [Astro](https://docs.astro.build).
1412

15-
Features:
13+
## ✨ Links & Resources
1614

17-
- ✅ Minimal styling (make it your own!)
18-
- ✅ 100/100 Lighthouse performance
19-
- ✅ SEO-friendly with canonical URLs and OpenGraph data
20-
- ✅ Sitemap support
21-
- ✅ RSS Feed support
22-
- ✅ Markdown & MDX support
23-
24-
## 🚀 Project Structure
25-
26-
Inside of your Astro project, you'll see the following folders and files:
27-
28-
```text
29-
├── public/
30-
├── src/
31-
│   ├── components/
32-
│   ├── content/
33-
│   ├── layouts/
34-
│   └── pages/
35-
├── astro.config.mjs
36-
├── README.md
37-
├── package.json
38-
└── tsconfig.json
39-
```
40-
41-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
42-
43-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
44-
45-
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.
46-
47-
Any static assets, like images, can be placed in the `public/` directory.
15+
- Looking to get started with Juno? Check out the [documentation](https://juno.build).
16+
- Have a look at the [Astro](https://docs.astro.build) for question regarding the templates.
17+
- Have questions, comments or feedback? [Join our discord](https://discord.gg/wHZ57Z2RAG) or [OpenChat](https://oc.app/community/vxgpi-nqaaa-aaaar-ar4lq-cai/?ref=xanzv-uaaaa-aaaaf-aneba-cai).
4818

4919
## 🧞 Commands
5020

5121
All commands are run from the root of the project, from a terminal:
5222

53-
| Command | Action |
54-
| :------------------------ | :----------------------------------------------- |
55-
| `npm install` | Installs dependencies |
56-
| `npm run dev` | Starts local dev server at `localhost:4321` |
57-
| `npm run build` | Build your production site to `./dist/` |
58-
| `npm run preview` | Preview your build locally, before deploying |
59-
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
60-
| `npm run astro -- --help` | Get help using the Astro CLI |
61-
62-
## 👀 Want to learn more?
63-
64-
Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
23+
| Command | Action |
24+
|:-----------------|:--------------------------------------------|
25+
| `npm install` | Installs dependencies |
26+
| `npm run dev` | Starts local dev server at `localhost:4321` |
27+
| `npm run build` | Build your production site to `./dist/` |
28+
| `juno deploy` | Deploy your project to a Satellite |
6529

66-
## Credit
30+
## 🚀 Launch
6731

68-
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).
32+
Explore this [guide](https://juno.build/docs/add-juno-to-an-app/create-a-satellite) to launch your Satellite into orbit via Juno's [administration console](https://console.juno.build).
2.42 MB
Loading

0 commit comments

Comments
 (0)