heimoshuiyu/aether
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readme to reflect newest changes

Browse Source
This commit is contained in:
Joe Hutchinson
2019-07-20 22:06:14 -04:00
parent b31a96f27a
commit 4a13ce6337
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -107,15 +107,15 @@ Shortcodes extend markdown to make writing easier and more powerful.
`image` is how you add WebP images to your posts with a fallback in case WebP is not supported. Image just needs the src and alt parameters. WebP is a next-gen image format that was created to make the web fast. To use the image shortcode simply store a WebP image with the same name in the same directory as your normal image.
```html
<!--- Will display a WebP image on supported browsers if post/awesome-post/awesome.webp exists -->
{{<image src="post/awesome-post/awesome.jpg" alt="An awesome image that will use webp when possible. Much faster!" >}}
<!--- Will display a WebP image on supported browsers if awesome.webp exists -->
{{<image src="awesome.jpg" alt="An awesome image that will use webp when possible. Much faster!" >}}
```
`smallimg` allows you to add images to your posts without stretching them to be as wide as the content area. Smallimg takes the parameters src, alt, smartfloat (optional), and width (optional). The smartfloat parameter can be set to right or left, and it floats the image to the right or left on big enough screens.
```html
<!--- smallimg will also display a WebP image on supported browsers if post/smile-post/smile.webp exists -->
{{<smallimg src="post/smile-post/smile.png" alt="A big beautiful smile" smartfloat="left" width="100px">}}
<!--- smallimg will also display a WebP image on supported browsers if smile.webp exists -->
{{<smallimg src="smile.png" alt="A big beautiful smile" smartfloat="left" width="100px">}}
```
### Further Customization