Skip to content

Commit

Permalink
FIX: Update README.md (#7)
Browse files Browse the repository at this point in the history
Fix image path in "Images" section of docs
  • Loading branch information
martin-brennan authored Sep 9, 2024
1 parent d1ed6d4 commit 2714de7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ How to develop themes:
Images (e.g. screenshots) for docs can be stored in the `/assets` directory. To reference them from the markdown, use the standard markdown image syntax, with a path like `/assets/my-image.png`. For example:

```
![some alt text](/assets/images/my-image.png)
![some alt text](/assets/my-image.png)
```

The sync tool will automatically upload the images to Discourse, and replace the path with a discourse-specific `upload://` path. A mapping of repo-path to discourse-path will be persisted in an HTML comment at the end of the doc's topic.
Expand Down Expand Up @@ -125,4 +125,4 @@ When working on substantial changes, you may like to set up a staging environmen
```
For debugging, the script accepts a `-v` flag.
5. Once the script has completed the first run, all the topics should be visible in Discourse. Any edits to markdown files will be synced instantaneously to Discourse.
5. Once the script has completed the first run, all the topics should be visible in Discourse. Any edits to markdown files will be synced instantaneously to Discourse.

0 comments on commit 2714de7

Please sign in to comment.