Skip to content

Commit

Permalink
update readme with description on how to change the content of the we…
Browse files Browse the repository at this point in the history
…bsite
  • Loading branch information
DasUnicorn committed Jan 24, 2024
1 parent 3eaaa86 commit 4682a0b
Showing 1 changed file with 31 additions and 4 deletions.
35 changes: 31 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,37 @@
# HüPC Homepage

## Update Content

The text content of this website is stored in markdown files, to make it easier for non-it-people to edit.
If you've never used Markdown before, [here is a cheat sheet](https://www.markdownguide.org/cheat-sheet/) with the most comman styling you might need.

To update the text of this website, you have to navigate into the *src/content* folder.
Here you will find two folders, 'pages' and 'shorts', as well as the file main-infos.md

```
/
├── public/
│ └── pictures
├── src/
│ ├── content/
│ │ └── pages
│ │ └── shorts
│ │ └── main-infos.md
```

* **main-infos.md** stores what will be rendered as date (Datum), place (Ort) and price (Preis) on the landing page of this project.
* **shorts** includes all short intro texts of the landing page
* **pages** includes the text of all web pages. Each page has it's own document.

To edit the text on the homepage, you have to edit the responding markdown file.

## Development

tldr:
* `yarn install`
* `yarn dev`

## 🧞 Commands
### 🧞 Commands

All commands are run from the root of the project, from a terminal:

Expand All @@ -18,7 +45,7 @@ All commands are run from the root of the project, from a terminal:
| `yarn run astro -- --help` | Get help using the Astro CLI |


## 🚀 Project Structure
### 🚀 Project Structure

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

Expand All @@ -42,6 +69,6 @@ There's nothing special about `src/components/`, but that's where we like to put

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

## 👀 Want to learn more?
### 👀 Want to learn more?

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
Feel free to check [the astro documentation](https://docs.astro.build) or jump into the astroc [Discord server](https://astro.build/chat).

0 comments on commit 4682a0b

Please sign in to comment.