postctl

package

v0.0.0-...-d78814b Latest Latest Go to latest Published: Oct 22, 2019 License: GPL-2.0 Imports: 24 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kirsle/blog

Links

Open Source Insights

Documentation ¶

Overview ¶

Package postctl implements all the web blog features.

Routes

Public
/blog             Blog index
/blog.rss         RSS feed
/blog.atom        Atom feed
/archive          Blog archives
/tagged           Index of all blog tags
/tagged/<tag>     View posts by tag
/<fragment>       View blog entry by its URL fragment

Admin Only
/blog/edit        Create or edit blog post
/blog/delete      Confirm deletion of blog post
/blog/drafts      View all draft entries
/blog/private     View all private entries

Related Models

posts

Description ¶

Each post is in its own JsonDB document at `posts/entries/<id>.json` and contains all its data (title, body, tags, timestamps, etc.)

For faster retrieval and caching of overall post data, there is a Blog Index that gets saved in JsonDB at `posts/index.json`. The index summarizes ALL of the blog posts by caching their basic details (ID, URL fragment, title, tags, created time). This document is used for getting a narrower list of posts to work with, for index pages (with pagination), "by tagged" pages, etc.

Usually the front-end settles on 5 or 10 posts it wants to render, and it only had to look at the index. For the archive view where it only needs the blog titles, it already has these too. For the posts where it needs the full body, it has the IDs and can just select each one pretty quickly.

In case anything goes wrong with the blog index, you can always delete the `posts/index.json` and it will be re-generated from scratch in a one-time scan of the entire posts DB (opening every document).

Index ¶

Variables
func RecentPosts(r *http.Request, tag, privacy string) []posts.Post
func Register(r *mux.Router, loginError http.HandlerFunc)
func ViewPost(w http.ResponseWriter, r *http.Request, fragment string) error
type Archive
type PostMeta

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	FeedPostsPerPage = 20
)

Feed configuration. TODO make configurable.

Functions ¶

func RecentPosts ¶

func RecentPosts(r *http.Request, tag, privacy string) []posts.Post

RecentPosts gets and filters the blog entries and orders them by most recent.

func Register ¶

func Register(r *mux.Router, loginError http.HandlerFunc)

Register the blog routes to the app.

func ViewPost ¶

func ViewPost(w http.ResponseWriter, r *http.Request, fragment string) error

ViewPost is the underlying implementation of the handler to view a blog post, so that it can be called from non-http.HandlerFunc contexts. Specifically, from the catch-all page handler to allow blog URL fragments to map to their post.

Types ¶

type Archive ¶

type Archive struct {
	Label string
	Date  time.Time
	Posts []posts.Post
}

Archive holds data for a piece of the blog archive.

type PostMeta ¶

type PostMeta struct {
	Post        *posts.Post
	Rendered    template.HTML
	Author      *users.User
	NumComments int
	IndexView   bool
	Snipped     bool
}

PostMeta associates a Post with injected metadata.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL