Skip to content

Commit

Permalink
feat: new website
Browse files Browse the repository at this point in the history
  • Loading branch information
ido-pluto committed Nov 21, 2023
1 parent a0f9dd8 commit da6272b
Show file tree
Hide file tree
Showing 54 changed files with 4,784 additions and 9,377 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
github: ido-pluto
github: ido-pluto
8 changes: 2 additions & 6 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
Expand All @@ -22,10 +22,6 @@ jobs:
uses: actions/checkout@v3
- name: Install, build, and upload your site
uses: withastro/action@v0
# with:
# path: . # The root location of your Astro project inside the repository. (optional)
# node-version: 16 # The specific version of Node that should be used to build your site. Defaults to 16. (optional)
# package-manager: yarn # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)

deploy:
needs: build
Expand All @@ -36,4 +32,4 @@ jobs:
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v1
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/
Expand Down
5 changes: 5 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 12 additions & 0 deletions .idea/astro-utils-docs.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

57 changes: 41 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,53 @@
# Astro-Metro: Docs Site
# Starlight Starter Kit: Basics

The source code of [Astro-Metro docs](https://astro-metro.github.io/docs) site.
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

## Share an Idea
💡 Got an idea to share?
```
npm create astro@latest -- --template starlight
```

💬 Join the discussions and let us know!
[![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)

🤝 We welcome all ideas, big or small, and value your contribution.
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
🚀 Let's work together to make this project even better! 💪
## 🚀 Project Structure

## Contribution
Have you come across a problem or issue with our project? Don't worry, we're here to help! Our Github repository has a dedicated section for issues, where you can report any bugs, errors, or other issues you may have encountered.
Inside of your Astro + Starlight project, you'll see the following folders and files:

To create an issue, simply click on the "Issues" tab and follow the prompts. Be sure to include a clear and concise title, as well as a detailed description of the issue and any relevant information, such as steps to reproduce or error messages.
```
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ │ └── config.ts
│ └── env.d.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
```

Once you've created an issue, our team will work to address the problem and provide a solution as soon as possible. So if you run into any issues with our project, don't hesitate to report them through the issues section. Together, we can work to make our project even better!
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.

## Add Translate
Want to help translate our project into a different language? Great! We welcome contributions from translators of all skill levels.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.

To add a translation to our project, you will need to create a pull request (PR). A PR is a request to merge your changes into the main branch of the project.
Static assets, like favicons, can be placed in the `public/` directory.

To create a PR, first fork the repository and create a new branch for your translation. Then, make your translation changes and commit them to the branch. Once you're ready to submit your translation for review, open a PR and provide a brief description of your changes.
## 🧞 Commands

Our team will review your PR and, if everything looks good, we will merge it into the main branch of the project. Thanks for your contribution! We appreciate your help in making our project more accessible to a wider audience.
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).
35 changes: 25 additions & 10 deletions astro.config.mjs
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
import { defineConfig } from 'astro/config';
import preact from '@astrojs/preact';
import react from '@astrojs/react';
import starlight from '@astrojs/starlight';

import expressiveCode from "astro-expressive-code";

// https://astro.build/config
export default defineConfig({
integrations: [
// Enable Preact to support Preact JSX components.
preact(),
// Enable React for the Algolia search component.
react(),
],
site: 'https://astro-metro.github.io',
base: '/docs',
integrations: [expressiveCode(), starlight({
favicon: '/favicon.png',
title: 'Astro Utils',
logo: {
src: '/src/assets/logo.png'
},
social: {
github: 'https://github.com/withastro-utils/utils'
},
sidebar: [{
label: 'Guides',
autogenerate: {
directory: 'guides'
}
}, {
label: 'Reference',
autogenerate: {
directory: 'reference'
}
}],
customCss: ['./src/styles/home.css', './src/styles/code-margin.css']
})]
});
Loading

0 comments on commit da6272b

Please sign in to comment.