|
2 | 2 |
|
3 | 3 | This repository hosts the website for the [Serveless Workflow Specification](https://github.com/serverlessworkflow/specification) project at [https://serverlessworkflow.io](https://serverlessworkflow.io).
|
4 | 4 |
|
5 |
| -## Contributing to the website |
| 5 | +## 🧑 Contributing to the website |
6 | 6 |
|
7 |
| -The website uses [Hugo](https://gohugo.io/) and [Docsy](https://www.docsy.dev/). You can find more information about how to get started with this stack [here](https://www.docsy.dev/docs/get-started/). |
| 7 | +The website uses [Astro](https://astro.build/). You can find more information about how to get started with this stack [here](https://docs.astro.build/en/getting-started/). |
| 8 | + |
| 9 | +For the styling, it relies on [TailWind CSS](https://tailwindcss.com/) and [Daisy UI](https://daisyui.com/). |
8 | 10 |
|
9 | 11 | To contribute to the website you don't need to have in-deth web design knowledge:
|
| 12 | +- To publish a blog post just add a new Markdown page to the [`blog`](src/content/blog) directory. You can always use the blog posts in this repository as a reference. |
| 13 | +- For more complex changes to the website, have a look at the [Astro Docs](https://docs.astro.build/en/getting-started/) |
| 14 | + |
| 15 | +## 🚀 Project Structure |
| 16 | + |
| 17 | +To learn more about the folder structure of an Astro project, refer to [our guide on project structure](https://docs.astro.build/en/basics/project-structure/). |
| 18 | + |
| 19 | +## 🧞 Commands |
| 20 | + |
| 21 | +All commands are run from the root of the project, from a terminal: |
| 22 | + |
| 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 | +| `npm run preview` | Preview your build locally, before deploying | |
| 29 | +| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
| 30 | +| `npm run astro -- --help` | Get help using the Astro CLI | |
| 31 | + |
| 32 | + |
| 33 | +Alternatively, you can use Docker to run the project and connect on `localhost:4321`: |
| 34 | +``` |
| 35 | +docker compose up --remove-orphans --watch |
| 36 | +``` |
| 37 | + |
| 38 | +## 👀 Want to learn more? |
10 | 39 |
|
11 |
| -- To add a new content [follow this guide](https://www.docsy.dev/docs/adding-content/content/) |
12 |
| -- To publish a blog post just add a new Markdown page to the [`blog`](blog) directory. You can always use the blog posts in this repository as a reference. [Here's a good example](https://github.com/google/docsy-example/blob/main/content/en/blog/releases/in-depth-monoliths-detailed-spec.md). |
13 |
| -- For more complex changes to the website, look at the [Docsy](https://github.com/google/docsy) repository as a reference. Sometimes you might need to change the [default templates](https://github.com/google/docsy/tree/main/layouts) to accomodate custom changes. |
| 40 | +Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
0 commit comments