summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSerghei Iakovlev <egrep@protonmail.ch>2022-07-24 21:16:59 +0200
committerSerghei Iakovlev <egrep@protonmail.ch>2022-07-24 21:16:59 +0200
commit5c50d1be986dcdd1c92d1e646f2016ea5b61b900 (patch)
treefcf1b0b8f868f8b5e0fb2d349eff447b5b27705f /README.md
parentf455db5d6f8aaf17f6a80ad69ef84750583ce121 (diff)
downloadgohugo-theme-ed-5c50d1be986dcdd1c92d1e646f2016ea5b61b900.tar.gz
Update documentation
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/README.md b/README.md
index f1647ba..d216696 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-<h1 align=center>Ed | <a href="https://gohugo-theme-ed.netlify.app/" rel="nofollow">Demo</a></h1>
+<h1 align=center>Ed | <a href="https://gohugo-theme-ed.netlify.app/?utm_source=github.com&utm_campaign=docs&utm_medium=smm">Demo</a></h1>
Ed is a [Hugo](http://gohugo.io) theme designed for textual editors based on
[minimal computing](http://go-dh.github.io/mincomp/) principles, and focused
@@ -18,8 +18,8 @@ theme by [Alex Gil](https://twitter.com/elotroalex).
## Sample Ed editions
-- [Our sample site](https://gohugo-theme-ed.netlify.app/) is the first edition built with Ed.
-- [Serghei Iakovlev's blog](https://serghei.blog/?utm_source=ed&utm_campaign=docs&utm_medium=smm)
+- [Our sample site](https://gohugo-theme-ed.netlify.app/?utm_source=github.com&utm_campaign=docs&utm_medium=smm) is the first edition built with Ed.
+- [Serghei Iakovlev's blog](https://serghei.blog/?utm_source=github.com&utm_campaign=docs&utm_medium=smm)
## Features
@@ -33,10 +33,16 @@ theme by [Alex Gil](https://twitter.com/elotroalex).
- Metadata in OpenGraph to play nice with social media and search engines
- Automatic table of content generation
- Simple search functionality
+- Annotations via [hypothes.is](https://hypothes.is/)
- Contact form
- Custom `robots.txt` (changes values based on environment)
- RSS/Atom/Json Feeds Discovery
+## Installing and using Ed
+
+To learn how to install and begin using Ed, please visit our
+[documentation page](https://gohugo-theme-ed.netlify.app/documentation/?utm_source=github.com&utm_campaign=docs&utm_medium=smm).
+
## License
Ed licensed under the MIT License. See the [LICENSE](https://raw.githubusercontent.com/sergeyklay/gohugo-theme-ed/master/LICENSE) file for more information.