Skip to content

Commit

Permalink
Add info on images (#60)
Browse files Browse the repository at this point in the history
  • Loading branch information
pkeilbach authored Dec 22, 2023
1 parent 7cdd74d commit 76c93a0
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions docs/presentations/presentations.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,17 +51,27 @@ This is the preferred way to submit the article. 🤓

1. **Add your aricle to the repository**

Please add your article to the `docs/presentations/articles/` folder and name it `<your topic>.md`.
Please add your article to the `docs/presentations/articles/` folder and name it `your_topic.md`. Please use [snake case](https://en.wikipedia.org/wiki/Snake_case) for the file name.

!!! info "Assets"

If you want to include images or other assets, please add them to the `docs/presentations/articles/assets/` folder.
If you want to use images in your article, please try to include them from public sources like Wikipedia or Wikimedia Commons. Please make sure to include the link in a separate reference section to avoid licensing issues.

In Markdown, you can include images like this:

```md
![alt text](https://example.com/image.png)
```

In case you need to include images or other assets as files (e.g. a diagram you created by yourself), please add them to the `docs/presentations/articles/assets/` folder.

Please use [kebab case](https://en.wikipedia.org/wiki/Kebab_case) for the asset file names, and prefix them with the topic name, e.g. `your-topic-image.png`.

From your markdown file, you can then reference the assets like this:

```md
<!-- the relative link is important -->
![alt text](./assets/image.png)
![alt text](./assets/your-topic-image.png)
```

2. **Include the article in the `mkdocs.yml` file**
Expand Down

0 comments on commit 76c93a0

Please sign in to comment.