Skip to content

Commit

Permalink
Merge pull request #11 from athega/ph/update-README
Browse files Browse the repository at this point in the history
doc: Update README
  • Loading branch information
peterhellberg authored Jan 16, 2025
2 parents 2654de7 + d3a3a0b commit faa67a0
Showing 1 changed file with 68 additions and 37 deletions.
105 changes: 68 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,88 @@
# athega.github.io
The Athega GitHub Place

> The Athega GitHub Place
## Uppdatera sajten

### Första gången
```
### Utvecklingsberoenden

#### Ruby Version Manager (RVM)

```console
\curl -sSL https://get.rvm.io | bash -s stable
```

> [!TIP]
> Verifiera att din installation av RVM fungerar mha `rvm --version`
### Första gången behöver du klona repot och köra `bundle install`
```console
git clone [email protected]:athega/athega.github.io.git
cd athega.github.io
gem install bundler
bundle install
```

### Följande gånger räcker det med att hämta eventuella ändringar

```console
git pull --rebase
```

### Om du vill
### Starta en lokal server
```console
bundle exec jekyll serve
```
bundle update

> [!TIP]
> Nu kan du titta på sajten lokalt på <http://localhost:4000/>
### Diverse kommandon

#### Hämta eventuella ändringar i repot från GitHub

```console
git pull --rebase
```

### Lokal server
#### Lägg till en commit

Efter att du gjort din ändring så kan du;

```console
git add <filnamn>
git commit -m "Meddelande som beskriver ändringen"
```
bundle exec jekyll serve

#### Pusha dina ändringar till GitHub

```console
git push
```
Nu kan du titta på sajten lokalt på http://localhost:4000.

#### Uppdatera Ruby-beroenden

### Diverse kommandon
```console
bundle update
```

#### Hämta
git pull https://github.com/athega/athega.github.io.git

#### Commit
git commit <filnamn>

#### Push
git push https://github.com/athega/athega.github.io.git


#### Add blog post
1. Ladda upp bilderna man vill ha i posten.
a. Dom ska laddas upp under /athega.github.io/assets/img/blog/
2. Skapa en ny fil under posts med yyyy-mm-dd-namn-namn.md (Viktigt med md på slutet)
3. Lägg till huvud med
a. ---
b. title: "Titel"
c. date: 2015-04-14
d. description: "description."
e. tags:
- nyhetsbrev
f. last_updated_by: namn
g. image_url: /system/uploads/liten.jpg
h. ---
4. Skriv sedan bloggposten med Markdown
5. Preview
6. Commit new file - master uppdaterar siten i samma sekund
### Att lägga till en bloggpost

1. Ladda upp bilderna man vill ha med i posten.
- Dom ska laddas upp under `assets/blog/`
2. Skapa en ny fil under `_posts` med `yyyy-mm-dd-namn.md` _(Viktigt med `.md` på slutet)_
3. Lägg till metadata om posten likt följande i toppen av filen.
```yaml
---
title: "Titel"
date: 2015-04-14
description: "Kort beskrivning av bloggposten"
tags:
- blogg
last_updated_by: namn
image_url: /assets/blog/bilden.png
---
```
4. Skriv sedan bloggposten i [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
5. Förhandsgranska din ändring på <http://localhost:4000/>
6. Committa den nya filen och pusha till `master` (Eller skapa en **PR** först)
- När GitHub har behandlat ändringen _(via [Jekyll](https://jekyllrb.com/), vilket kan ta en stund)_ så uppdateras <https://athega.se/>

0 comments on commit faa67a0

Please sign in to comment.