diff options
author | Huy Nguyen <huyb.1991@gmail.com> | 2019-03-14 17:53:35 +0300 |
---|---|---|
committer | Huy Nguyen <huyb.1991@gmail.com> | 2019-03-14 17:53:35 +0300 |
commit | 327bfa58d24a65376283fb41cd62905635f0ae61 (patch) | |
tree | f28c2261d0444d230ab2506f9a6c628611f9b2bd /docs | |
parent | c2daec56f4c529a6486ee7166c6001606c246ba1 (diff) |
Update guide document
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content-editing.md | 23 | ||||
-rw-r--r-- | docs/guide.md (renamed from docs/configuration.md) | 24 |
2 files changed, 24 insertions, 23 deletions
diff --git a/docs/content-editing.md b/docs/content-editing.md deleted file mode 100644 index 84027b6..0000000 --- a/docs/content-editing.md +++ /dev/null @@ -1,23 +0,0 @@ -# Guides - -## Add image to article (content) - -This is an AMP page, to add image, you have to use [amp-img shortcodes](https://github.com/huyb1991/hugo-lamp/blob/master/layouts/shortcodes/amp-img.html), the syntax is: -``` -{{< amp-img width="width-value" height="height-value" layout="responsive" src="image-url" alt="image alt" >}} -``` -Replace `width-value`, `height-value`, `image alt` and `image-url` by your image. - -A note: Hugo is static-site-generator, to add image to your site, please follow this solution [[SOlved] How to… insert image in my post?](https://discourse.gohugo.io/t/solved-how-to-insert-image-in-my-post/1473). - -## Content config for SEO - -In Front Matter section for each post, you should add `title` and `description` for SEO, example: -```toml ---- -title: "Getting Started with AMP" -description: "Getting started with AMP. Implement these key steps to get up and running with AMP" ---- -``` -The `title` is the H1 tag on HTML page, and `<title>` in head section. -The `description` is the meta tag for description `<meta name="description" content="">` in head section. diff --git a/docs/configuration.md b/docs/guide.md index d0408ad..8488b4f 100644 --- a/docs/configuration.md +++ b/docs/guide.md @@ -1,3 +1,27 @@ +# Guides + +## Add image to article (content) + +This is an AMP page, to add image, you have to use [amp-img shortcodes](https://github.com/huyb1991/hugo-lamp/blob/master/layouts/shortcodes/amp-img.html), the syntax is: +``` +{{< amp-img width="width-value" height="height-value" layout="responsive" src="image-url" alt="image alt" >}} +``` +Replace `width-value`, `height-value`, `image alt` and `image-url` by your image. + +A note: Hugo is static-site-generator, to add image to your site, please follow this solution [[SOlved] How to… insert image in my post?](https://discourse.gohugo.io/t/solved-how-to-insert-image-in-my-post/1473). + +## Content config for SEO + +In Front Matter section for each post, you should add `title` and `description` for SEO, example: +```toml +--- +title: "Getting Started with AMP" +description: "Getting started with AMP. Implement these key steps to get up and running with AMP" +--- +``` +The `title` is the H1 tag on HTML page, and `<title>` in head section. +The `description` is the meta tag for description `<meta name="description" content="">` in head section. + # Configuration Take a look inside the [exampleSite](https://github.com/huyb1991/hugo-lamp/tree/master/exampleSite) at `config.toml` and update by your own: |