Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 28 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,51 @@
# gitify.io
# gitify.io

[![Netlify Status][netlify-badge]][netlify-deploys] [![Quality Gate Status][quality-badge]][quality] [![Renovate enabled][renovate-badge]][renovate] [![Contributors][contributors-badge]][github] [![OSS License][license-badge]][license]

> The source code for our gitify.io website
> The source code for [gitify.io](https://gitify.io), built with [Astro](https://astro.build).

> Made with Astro.
## πŸš€ Getting started

## πŸš€ Project Structure
Requires [pnpm](https://pnpm.io) and Node.js >= 24.

Inside of your Astro project, you'll see the following folders and files:
| Command | Action |
| --------------- | ----------------------------------------------- |
| `pnpm install` | Install dependencies |
| `pnpm dev` | Start the dev server at `http://localhost:4321` |
| `pnpm build` | Build the production site to `./dist/` |
| `pnpm preview` | Preview the production build |
| `pnpm lint` | Run Biome lint and apply fixes |

```
/
β”œβ”€β”€ public/
β”‚ └── favicon.svg
β”œβ”€β”€ src/
β”‚ β”œβ”€β”€ components/
β”‚ β”‚ └── Logo.astro
β”‚ β”œβ”€β”€ layouts/
β”‚ β”‚ └── Layout.astro
β”‚ └── pages/
β”‚ └── index.astro
└── package.json
```
## πŸ“ Content

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
FAQs are plain Markdown files in `src/faqs/<category>/<slug>.md`, rendered on the [FAQ page](https://gitify.io/faq). Each file needs the following frontmatter:

```yaml
---
title: "Question"
category: "Getting Started" # one of the four categories below
order: 0 # sorts within the category
---
```

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Categories: `Getting Started` Β· `Using Gitify` Β· `Troubleshooting` Β· `Contributing`

Any static assets, like images, can be placed in the `public/` directory.
## 🀝 Contributing

## 🧞 Commands
See [How to contribute](https://gitify.io/faq/#how-to-contribute) or read the [Code of Conduct](.github/CODE-OF-CONDUCT.md).

All commands are run from the root of the project, from a terminal:
## πŸ“„ License

| Command | Action |
| :------------------ | :------------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `http://localhost:4321` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm astro --help` | Get help using the Astro CLI |
Distributed under the [MIT License](LICENSE).

<!-- LINK LABELS -->
[github]: https://github.com/gitify-app/website
[contributors-badge]: https://img.shields.io/github/contributors/gitify-app/website?logo=github
[netlify-badge]: https://img.shields.io/netlify/a060080d-e0bd-46bf-a2b5-0290a18ead9d?logo=netlify&logoColor=white
[netlify-deploys]: https://app.netlify.com/projects/gitify/deploys
[license]: LICENSE
[license-badge]: https://img.shields.io/github/license/gitify-app/gitify?logo=github
[license-badge]: https://img.shields.io/github/license/gitify-app/website?logo=github
[renovate]: https://github.com/gitify-app/website/issues/15
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovate&logoColor=white
[quality]: https://sonarcloud.io/summary/new_code?id=gitify-app_website
[quality-badge]: https://img.shields.io/sonar/quality_gate/gitify-app_website?server=https%3A%2F%2Fsonarcloud.io&logo=sonarqubecloud
[quality-badge]: https://img.shields.io/sonar/quality_gate/gitify-app_website?server=https%3A%2F%2Fsonarcloud.io&logo=sonarqubecloud
Loading