diff --git a/assets/images/getting-started/wiki/wiki_editview.png b/assets/images/getting-started/wiki/wiki_editview.png new file mode 100644 index 0000000..6939bae Binary files /dev/null and b/assets/images/getting-started/wiki/wiki_editview.png differ diff --git a/content/getting-started/wiki.md b/content/getting-started/wiki.md index 5fb490c..26040f5 100644 --- a/content/getting-started/wiki.md +++ b/content/getting-started/wiki.md @@ -35,7 +35,19 @@ The web UI in your browser is currently limited to adding, updating, and deletin Wiki home page with edit buttons -## Adding content via a local Git client +### Adding external images via web +If you cannot [use a local Git client](#adding-external-images-via-web), linking to *external* assets like images is still possible. + + + + Web editor with an arrow pointing at the + + +Clicking on the "Insert Image" button will make the following text appear in your text editor: `![](https://)` + +You can read up more on how it works [in a later section](#describing-images-in-markdown). + +## Adding content using a local Git client You can work with the wiki repo as you would with any other Git repo on Codeberg; see our docs about managing a Git repo [via CLI](https://docs.codeberg.org/git/clone-commit-via-cli). ```shell @@ -47,7 +59,7 @@ git commit -am "create Home page" Editing locally allows you to use your favorite editor (preferably with Markdown syntax check and highlighting) and manage additional assets like images. -### Adding images +### Adding images using a local Git client You can add images to the root directory or a specific subfolder (like `assets` or `images`) using your local Git client. A feasible workflow might look like this: @@ -62,12 +74,22 @@ git commit -m "add image" git push ``` +## Attaching images in Markdown documents + Now, you can reference the image in Markdown, like this: +**File in repository**: ```markdown ![image alt text](images/image.png "image title") ``` +**External image**: +```markdown +![image alt text](https://example.com/image.jpg "image title") +``` + +When including images from Codeberg repositories, keep in mind that *you should use the raw version of the image.* + After saving your changes, the image should be visible. > In contrast to embedding external images, images in Git are only rendered after saving the wiki or Markdown file changes.