Skip to content

Commit

Permalink
update site
Browse files Browse the repository at this point in the history
  • Loading branch information
zensharp committed Sep 2, 2024
1 parent 1502c81 commit 4def114
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 65 deletions.
39 changes: 2 additions & 37 deletions .github/site/README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,5 @@
# Starlight Starter Kit: Basics

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```
npm create astro@latest -- --template starlight
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:
Expand All @@ -53,3 +16,5 @@ All commands are run from the root of the project, from a terminal:
## 👀 Want to learn more?

Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
2 changes: 1 addition & 1 deletion .github/site/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ export default defineConfig({
site: 'https://dotfiles.zensharp.net',
integrations: [
starlight({
title: 'Zensharp Dotfiles',
title: 'Dotfiles',
social: {
github: 'https://github.com/zensharp/dotfiles',
},
Expand Down
27 changes: 4 additions & 23 deletions .github/site/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Zencloud Dotfiles
description: Install dotfiles on a new computer.
template: splash
hero:
tagline: What operating system are we installing dotfiles on?
tagline: "Select an OS for guided configuration:"
actions:
- text: Windows
link: /playbooks/windows
Expand All @@ -15,26 +15,7 @@ hero:

# Quick Start
```
$ git clone https://github.com/zensharp/dotfiles
$ cd dotfiles
$ ./setup.sh
git clone https://github.com/zensharp/dotfiles
cd dotfiles
./setup.sh
```

import { Card, CardGrid } from '@astrojs/starlight/components';

## Next steps

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
</Card>
</CardGrid>
4 changes: 2 additions & 2 deletions .github/site/src/content/docs/playbooks/mac.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: macOS Installation
description: Installing dotfiles on macOS.
title: macOS Configuration
description: Configuration on macOS.
---

:::caution
Expand Down
4 changes: 2 additions & 2 deletions .github/site/src/content/docs/playbooks/windows.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Windows Installation
description: Installing dotfiles on Windows.
title: Windows Configuration
description: Configuration on Windows.
---

If you are coming from a fresh re-installation of Windows, delete previous versions of Windows in [Settings > Storage Management > Cleanup Recommendations](ms-settings:storagerecommendations)
Expand Down

0 comments on commit 4def114

Please sign in to comment.