Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
FuzzyReason committed Sep 14, 2023
0 parents commit 5c1de2a
Show file tree
Hide file tree
Showing 33 changed files with 7,189 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
4 changes: 4 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Starlight Starter Kit: Basics

```
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)

> 🧑‍🚀 **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:

| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `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 |

## 👀 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).
57 changes: 57 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'Refact Documentation',
logo: {
light: '/src/assets/logo.svg',
dark: '/src/assets/logo.svg',
replacesTitle: true,
},
social: {
github: 'https://github.com/smallcloudai',
discord: 'https://smallcloud.ai/discord'
},
sidebar: [
{
label: 'Getting Started',
items: [
{ label: 'What is Refact?', link: '/getting-started/what-is-refact/' },
{ label: 'Installation', link: '/getting-started/installation/' },
{ label: 'Plugin Setup', link: '/getting-started/plugin-setup/' },
{ label: 'Supported Models', link: '/getting-started/supported-models/' },
{ label: 'Privacy', link: '/getting-started/privacy/' },
{ label: 'Self-Hosted', link: '/getting-started/self-hosted/' },
],
},
{
label: 'Features',
items: [
{ label: 'AI Chat', link: '/features/ai-chat/' },
{ label: 'Code Completion', link: '/features/code-completion/' },
{ label: 'AI Toolbox', autogenerate: { directory: 'features/ai-toolbox' } },
]
},
{
label: 'Concepts',
autogenerate: { directory: 'concepts' },
},
{
label: 'Contributing',
link: '/contributing/',
},
{
label: 'Changelog',
link: '/changelog/',
}
],
customCss: [
// Relative path to your custom CSS file
'./src/styles/custom.css',
],
}),
],
});
Loading

0 comments on commit 5c1de2a

Please sign in to comment.