From b0eacbc55cb5e699875c0e998532d2b69b99553a Mon Sep 17 00:00:00 2001 From: Peter Tripp Date: Sat, 18 May 2024 15:13:32 -0400 Subject: [PATCH] Spiff up the readme a bit. (#2501) --- README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index bdcfd4aa..9c077165 100644 --- a/README.md +++ b/README.md @@ -5,30 +5,29 @@ A fast static site generator in a single binary with everything built-in. -Documentation is available on [its site](https://www.getzola.org/documentation/getting-started/installation/) or -in the `docs/content` folder of the repository and the community can use [its forum](https://zola.discourse.group). +To find out more see the [Zola Documentation](https://www.getzola.org/documentation/getting-started/overview/), look +in the [docs/content](docs/content) folder of this repository or visit the [Zola community forum](https://zola.discourse.group). -This tool and the template engine it is using were born from an intense dislike of the (insane) Golang template engine and therefore of +This tool and its template engine [tera](https://keats.github.io/tera/) were born from an intense dislike of the (insane) Golang template engine and therefore of Hugo that I was using before for 6+ sites. # List of features -- Single binary -- Syntax highlighting -- Sass compilation +- [Single binary](https://www.getzola.org/documentation/getting-started/cli-usage/) +- [Syntax highlighting](https://www.getzola.org/documentation/content/syntax-highlighting/) +- [Sass compilation](https://www.getzola.org/documentation/content/sass/) - Assets co-location -- (Basic currently) multilingual site suport -- Image processing -- Themes -- Shortcodes -- Internal links -- External link checker -- Table of contents automatic generation +- [Multilingual site suport](https://www.getzola.org/documentation/content/multilingual/) (Basic currently) +- [Image processing](https://www.getzola.org/documentation/content/image-processing/) +- [Themes](https://www.getzola.org/documentation/themes/overview/) +- [Shortcodes](https://www.getzola.org/documentation/content/shortcodes/) +- [Internal links](https://www.getzola.org/documentation/content/linking/) +- [External link checker](https://www.getzola.org/documentation/getting-started/cli-usage/#check) +- [Table of contents automatic generation](https://www.getzola.org/documentation/content/table-of-contents/) - Automatic header anchors -- Aliases -- Pagination -- Custom taxonomies -- Search with no servers or any third parties involved -- Live reload -- Deploy on many platforms easily: Netlify, Vercel, Cloudflare -- Breadcrumbs +- [Aliases](https://www.getzola.org/documentation/content/page/#front-matter) +- [Pagination](https://www.getzola.org/documentation/templates/pagination/) +- [Custom taxonomies](https://www.getzola.org/documentation/templates/taxonomies/) +- [Search with no servers or any third parties involved](https://www.getzola.org/documentation/content/search/) +- [Live reload](https://www.getzola.org/documentation/getting-started/cli-usage/#serve) +- Deploy on many platforms easily: [Netlify](https://www.getzola.org/documentation/deployment/netlify/), [Vercel](https://www.getzola.org/documentation/deployment/vercel/), [Cloudflare Pages](https://www.getzola.org/documentation/deployment/cloudflare-pages/), etc