Add some more documentation

dannyvankooten · Nov 22, 2023 · a6b821b · a6b821b
1 parent 1213325
commit a6b821b
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -15,14 +15,41 @@ Gozer expects a certain directory structure in order to build your site correctl
 
 ```txt
 content/        # Your posts and pages
+--- index.md    # Will be generated at build/index.html
+--- about.md    # Will be generated at build/about/index.html
 templates/      # Your Go templates
 public/         # Any static files
 config.xml      # Configuration file
 ```
 
-When running `gozer` in the root directory, your HTML site is built in the `build/` directory.
+## Commands
+
+- `gozer` Builds the site into `build/`
+- `gozer serve` Builds the site into `build/` and starts an HTTP server on `localhost:8080` serving the `build/` directory.
+
+## Content files
+
+Each file in your `content/` directory should end in `.md` and have front matter specifying the page title:
+
+```md
++++
+title = "My page title"
++++
+
+Page content here.
+```
+
+The default template for every page is `default.html`. You can override it by setting the `template` variable in your front matter.
+
+```md
++++
+title = "My page title"
+template = "special-page.html"
++++
+
+Page content here.
+```
 
-You can run `gozer serve` to build your site and start an HTTP server serving the `build/` directory locally.
 
 ## License
 

diff --git a/example/content/_index.md → example/content/index.md b/example/content/_index.md → example/content/index.md
diff --git a/example/templates/default.html b/example/templates/default.html
@@ -1,7 +1,12 @@
-<!DOCTYPE>
-<html>
+<!DOCTYPE html>
+<html lang="en">
     <head>
         <title>{{ .Title }}</title>
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width,initial-scale=1">
+        <link rel="canonical" href="{{ .SiteUrl }}{{ .Page.URLPath }}">
+        <link rel="alternate" type="application/rss+xml" href="/feed.xml">
+        <link rel="sitemap" type="application/xml" href="/sitemap.xml">
     </head>
     <body>
         {{ .Content }}

diff --git a/main.go b/main.go
@@ -72,7 +72,7 @@ func (p *Page) Dest() string {
 
 	d = strings.TrimSuffix(d, ".md")
 	d = strings.TrimSuffix(d, ".html")
-	d = strings.TrimSuffix(d, "_index")
+	d = strings.TrimSuffix(d, "index")
 
 	d += "/index.html"
 	return d