feat: add 404.html

cmd/pugo/main.go

@@ -21,7 +21,7 @@ var (
 			Name:  "version",
 			Usage: "print the version of PuGo",
 			Action: func(c *cli.Context) error {
-				fmt.Println(constants.AppName(), "v"+version)
+				fmt.Println(constants.AppName(), version)
 				return nil
 			},
 		},

pkg/cmd/server.go

@@ -35,7 +35,10 @@ func NewServer() *cli.Command {
 
 			generator.Generate(opt)
 
-			s := server.New(opt.OutputDir, c.Int("port"))
+			s := server.New(server.ServerOption{
+				Port: c.Int("port"),
+				Dir:  opt.OutputDir,
+			})
 			s.Run()
 
 			return nil

pkg/core/generator/render.go

@@ -8,16 +8,20 @@ import (
 )
 
 type renderBaseParams struct {
-	Ctx       *Context
-	Render    *theme.Render
-	OutputDir string
+	Ctx             *Context
+	Render          *theme.Render
+	OutputDir       string
+	SiteTitle       string
+	SiteDescription string
 }
 
 func newRenderBaseParams(siteData *SiteData, context *Context, opt *Option) renderBaseParams {
 	return renderBaseParams{
-		Ctx:       context,
-		Render:    siteData.Render,
-		OutputDir: opt.OutputDir,
+		Ctx:             context,
+		Render:          siteData.Render,
+		OutputDir:       opt.OutputDir,
+		SiteTitle:       siteData.SiteConfig.Title,
+		SiteDescription: siteData.SiteConfig.Description,
 	}
 }
 
@@ -26,8 +30,6 @@ func Render(siteData *SiteData, context *Context, opt *Option) error {
 	if err := renderPosts(&renderPostsParams{
 		renderBaseParams: renderBase,
 		Posts:            siteData.Posts,
-		SiteDesc:         siteData.SiteConfig.Description,
-		SiteTitle:        siteData.SiteConfig.Title,
 	}); err != nil {
 		zlog.Warnf("render posts failed: %v", err)
 		return err
@@ -37,7 +39,6 @@ func Render(siteData *SiteData, context *Context, opt *Option) error {
 		Pager:              siteData.PostsPager,
 		Posts:              siteData.Posts,
 		PostPageLinkFormat: siteData.BuildConfig.PostPageLinkFormat,
-		SiteTitle:          siteData.SiteConfig.Title,
 	}
 	if err := renderPostLists(postListParams); err != nil {
 		zlog.Warnf("render post lists failed: %v", err)
@@ -52,15 +53,13 @@ func Render(siteData *SiteData, context *Context, opt *Option) error {
 		Tags:              siteData.Tags,
 		PostPerPage:       siteData.BuildConfig.PostPerPage,
 		TagPageLinkFormat: siteData.BuildConfig.TagPageLinkFormat,
-		SiteTitle:         siteData.SiteConfig.Title,
 	}); err != nil {
 		zlog.Warnf("render tags failed: %v", err)
 		return err
 	}
 	if err := renderArchives(&renderArchivesParams{
 		renderBaseParams: renderBase,
 		Posts:            siteData.Posts,
-		SiteTitle:        siteData.SiteConfig.Title,
 		ArchivesLink:     siteData.BuildConfig.ArchivesLink,
 	}); err != nil {
 		zlog.Warnf("render archives failed: %v", err)
@@ -70,13 +69,19 @@ func Render(siteData *SiteData, context *Context, opt *Option) error {
 	if err := renderPages(&renderPagesParams{
 		renderBaseParams: renderBase,
 		Pages:            siteData.Pages,
-		SiteDesc:         siteData.SiteConfig.Description,
-		SiteTitle:        siteData.SiteConfig.Title,
 	}); err != nil {
 		zlog.Warnf("render pages failed: %v", err)
 		return err
 	}
 
+	if err := renderErrorPage(&renderErrorPageParams{
+		renderBaseParams: renderBase,
+		SiteTitle:        siteData.SiteConfig.Title,
+	}); err != nil {
+		zlog.Warnf("render error page failed: %v", err)
+		return err
+	}
+
 	// render feed
 	out, err := feed.Render(&feed.RenderParams{
 		Posts:       siteData.Posts,

pkg/core/generator/render_archives.go

@@ -13,7 +13,6 @@ import (
 type renderArchivesParams struct {
 	renderBaseParams
 	Posts        []*models.Post
-	SiteTitle    string
 	ArchivesLink string
 }
 
@@ -23,7 +22,8 @@ func renderArchives(params *renderArchivesParams) error {
 	extData := map[string]interface{}{
 		"archives": archives,
 		"current": map[string]interface{}{
-			"Title": params.SiteTitle,
+			"Title":       params.SiteTitle,
+			"Description": params.SiteDescription,
 		},
 	}
 	tplData := params.Ctx.createTemplateData(extData)

pkg/core/generator/render_errorpage.go

@@ -0,0 +1,32 @@
+package generator
+
+import (
+	"bytes"
+	"path/filepath"
+	"pugo/pkg/utils/zlog"
+)
+
+type renderErrorPageParams struct {
+	renderBaseParams
+	SiteTitle string
+}
+
+func renderErrorPage(params *renderErrorPageParams) error {
+	notFoundTpl := params.Render.GetTemplate("404")
+	tplData := params.Ctx.createTemplateData(map[string]interface{}{
+		"current": map[string]interface{}{
+			"Title": params.SiteTitle,
+		},
+	})
+
+	buf := bytes.NewBuffer(nil)
+	if err := params.Render.Execute(buf, notFoundTpl, tplData); err != nil {
+		zlog.Warn("failed to render 404", "err", err)
+		return err
+	}
+	link := "/404.html"
+	dstFile := filepath.Join(params.OutputDir, link)
+	params.Ctx.SetOutput(dstFile, link, buf)
+	zlog.Infof("404 generated: %s", dstFile)
+	return nil
+}

pkg/core/generator/render_pages.go

@@ -13,9 +13,7 @@ import (
 
 type renderPagesParams struct {
 	renderBaseParams
-	Pages     []*models.Page
-	SiteDesc  string
-	SiteTitle string
+	Pages []*models.Page
 }
 
 func renderPages(params *renderPagesParams) error {
@@ -28,7 +26,7 @@ func renderPages(params *renderPagesParams) error {
 			if page.Descripition != "" {
 				return page.Descripition
 			}
-			return params.SiteDesc
+			return params.SiteDescription
 		}
 	)
 	// build each page

pkg/core/generator/render_posts.go

@@ -12,9 +12,7 @@ import (
 
 type renderPostsParams struct {
 	renderBaseParams
-	Posts     []*models.Post
-	SiteDesc  string
-	SiteTitle string
+	Posts []*models.Post
 }
 
 func renderPosts(params *renderPostsParams) error {
@@ -28,7 +26,7 @@ func renderPosts(params *renderPostsParams) error {
 			if post.Descripition != "" {
 				return post.Descripition
 			}
-			return params.SiteDesc
+			return params.SiteDescription
 		}
 	)
 
@@ -81,7 +79,6 @@ type renderPostListsParams struct {
 	Pager              *models.Pager
 	Posts              []*models.Post
 	PostPageLinkFormat string
-	SiteTitle          string
 }
 
 func buildPostListTemplateData(params *renderPostListsParams, page int) (map[string]interface{}, *models.PagerItem) {
@@ -90,7 +87,8 @@ func buildPostListTemplateData(params *renderPostListsParams, page int) (map[str
 		"posts": models.PostsPageList(params.Posts, pageItem),
 		"pager": pageItem,
 		"current": map[string]interface{}{
-			"Title": params.SiteTitle,
+			"Title":       params.SiteTitle,
+			"Description": params.SiteDescription,
 		},
 	})
 	return tplData, pageItem

pkg/core/generator/render_tags.go

@@ -15,7 +15,6 @@ type renderTagsParams struct {
 	Tags              []*models.TagPosts
 	PostPerPage       int
 	TagPageLinkFormat string
-	SiteTitle         string
 }
 
 func renderTags(params *renderTagsParams) error {
@@ -39,7 +38,8 @@ func renderTags(params *renderTagsParams) error {
 				"pager": pageItem,
 				"tag":   tagData.Tag,
 				"current": map[string]interface{}{
-					"Title": tagData.Tag.Name + "-" + params.SiteTitle,
+					"Title":       tagData.Tag.Name + "-" + params.SiteTitle,
+					"Description": tagData.Tag.Name + " - " + params.SiteDescription,
 				},
 			})
 

pkg/core/server/server.go

@@ -8,21 +8,24 @@ import (
 
 // Server is the server.
 type Server struct {
-	dir  string
-	port int
+	opt ServerOption
+}
+
+type ServerOption struct {
+	Port int
+	Dir  string
 }
 
 // New returns a new server.
-func New(dir string, port int) *Server {
+func New(opt ServerOption) *Server {
 	return &Server{
-		dir:  dir,
-		port: port,
+		opt: opt,
 	}
 }
 
 // Run runs the server.
 func (s *Server) Run() error {
-	http.Handle("/", http.FileServer(http.Dir(s.dir)))
-	zlog.Infof("listening on port %d, serving %s", s.port, s.dir)
-	return http.ListenAndServe(":"+fmt.Sprintf("%d", s.port), nil)
+	http.Handle("/", http.FileServer(http.Dir(s.opt.Dir)))
+	zlog.Infof("listening on port %d, serving %s", s.opt.Port, s.opt.Dir)
+	return http.ListenAndServe(":"+fmt.Sprintf("%d", s.opt.Port), nil)
 }

pkg/core/theme/config.go

@@ -2,22 +2,24 @@ package theme
 
 // Config is the theme config.
 type Config struct {
-	Name            string   `toml:"name"`
-	IndexTemplate   string   `toml:"index_template"`
-	Extension       []string `toml:"extension"`
-	StaticDirs      []string `toml:"static_dirs"`
-	EnableDarkMode  bool     `toml:"enable_dark_mode"`
-	ShowPuGoVersion bool     `toml:"show_pugo_version"`
+	Name             string   `toml:"name"`
+	IndexTemplate    string   `toml:"index_template"`
+	NotFoundTemplate string   `toml:"not_found_template"`
+	Extension        []string `toml:"extension"`
+	StaticDirs       []string `toml:"static_dirs"`
+	EnableDarkMode   bool     `toml:"enable_dark_mode"`
+	ShowPuGoVersion  bool     `toml:"show_pugo_version"`
 }
 
 // NewDefaultConfig returns default theme config
 func NewDefaultConfig() *Config {
 	return &Config{
-		Name:            "theme",
-		Extension:       []string{".html"},
-		IndexTemplate:   "post-list.html",
-		StaticDirs:      []string{"static"},
-		EnableDarkMode:  false,
-		ShowPuGoVersion: false,
+		Name:             "theme",
+		Extension:        []string{".html"},
+		IndexTemplate:    "post-list.html",
+		NotFoundTemplate: "404.html",
+		StaticDirs:       []string{"static"},
+		EnableDarkMode:   false,
+		ShowPuGoVersion:  false,
 	}
 }

pkg/core/theme/theme.go

@@ -209,7 +209,18 @@ func (r *Render) Execute(w io.Writer, name string, data interface{}) error {
 
 // GetIndexTemplate gets index template
 func (r *Render) GetIndexTemplate() string {
-	return r.config.IndexTemplate
+	return r.GetTemplate("index")
+}
+
+// GetTemplate gets template by name
+func (r *Render) GetTemplate(name string) string {
+	if name == "index" || name == "home" {
+		return r.config.IndexTemplate
+	}
+	if name == "notfound" || name == "error" || name == "404" || name == "not-found" {
+		return r.config.NotFoundTemplate
+	}
+	return ""
 }
 
 // GetDir gets theme dir

themes/default/404.html

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+{{template "head.html" .}}
+
+<body>
+    {{template "header.html" .}}
+    <main class="main">
+        <div class="main-container">
+            <div class="not-found">
+                <h1>404</h1>
+                <p>Sorry, this page does not exist.</p>
+                <p>You can head back to the <a href="/">homepage</a>.</p>
+            </div>
+        </div>
+    </main>
+    {{template "footer.html" .}}
+</body>
+
+</html>

themes/default/footer.html

@@ -8,7 +8,7 @@
         <div class="footer-right">
             {{- if .server.Local}}<span>Local Server</span><span class="post-meta-gap">|</span>{{end -}}
             <span>Base on <a href="https://github.com/fuxiaohei/pugo" target="_blank"
-                    class="footer-item">{{.pugo.Name}}{{if .theme.ShowPuGoVersion}} v{{.pugo.Version}}{{end}}</a></span>
+                    class="footer-item">{{.pugo.Name}}{{if .theme.ShowPuGoVersion}} {{.pugo.Version}}{{end}}</a></span>
         </div>
     </div>
 </footer>

themes/default/partial/analytics.html

@@ -48,4 +48,5 @@
 {{end -}}
 {{end -}}
 
+
 {{end -}}

themes/default/partial/sidebar.html

@@ -1,21 +1,20 @@
-<div class="sidebar">
-    <div class="sidebar-profile">
-        <div class="profile-card mx-auto">
-            <img class="profile-avatar" src="{{.author.AvatarLink}}" alt="">
-            <div class="profile-name">{{.author.Name}}</div>
-            <div class="profile-bio">{{.author.Bio}}</div>
-            {{if .author.HasSocials}}{{template "partial/social.html" .}}{{end}}
+<div class="main-sidebar">
+    <div class="sidebar">
+        <div class="sidebar-profile">
+            <div class="profile-card mx-auto">
+                <img class="profile-avatar" src="{{.author.AvatarLink}}" alt="">
+                <div class="profile-name">{{.author.Name}}</div>
+                <div class="profile-bio">{{.author.Bio}}</div>
+                {{if .author.HasSocials}}{{template "partial/social.html" .}}{{end}}
+            </div>
         </div>
-    </div>
-    <div class="sidebar-tags">
-        <h4 class="tags-title">Tags</h4>
-        <div class="tags-list">
-            {{range .tags}}<a
-                class=""
-                href="{{.Link}}">
-                {{.Name}}<span
-                    class="tags-post-count">{{.PostCount}}</span>
-            </a>{{end}}
+        <div class="sidebar-tags">
+            <h4 class="tags-title">Tags</h4>
+            <div class="tags-list">
+                {{range .tags}}<a class="" href="{{.Link}}">
+                    {{.Name}}<span class="tags-post-count">{{.PostCount}}</span>
+                </a>{{end}}
+            </div>
         </div>
     </div>
 </div>