sites115

README

sites115

a webmaster's assistant

sites115 is all about markdown.

It enables searching markdown files without a database. This would improve the performance of websites as well as reduce the costs.

sites115 is not a full Content Management System (CMS).

How to Use

Take a look at the demo folder included.

Notable Points

1. Have a folder containing markdown files

2. The make file for building the search indexes. It can be replaced with github actions

3. The sites115 library for interacting with the search indexes.

4. Sites115 is not a complete website or CMS

Documentation

Index

• Variables
• type S1Object
  • func Init(mdTarPath, idxTarPath string) (S1Object, error)
  • func (s1o *S1Object) ReadAllMD() ([]string, error)
  • func (s1o *S1Object) ReadMDAbstract(path string) (string, error)
  • func (s1o *S1Object) ReadMDAsHTML(path string) (string, error)
  • func (s1o *S1Object) ReadMDTitle(path string) (string, error)
  • func (s1o *S1Object) Search(searchStr string) ([]string, error)

Variables

var StopWordsBytes []byte

Types

type S1Object

type S1Object struct {
	// contains filtered or unexported fields
}

func Init

func Init(mdTarPath, idxTarPath string) (S1Object, error)

func (*S1Object) ReadAllMD

func (s1o *S1Object) ReadAllMD() ([]string, error)

func (*S1Object) ReadMDAbstract

func (s1o *S1Object) ReadMDAbstract(path string) (string, error)

func (*S1Object) ReadMDAsHTML

func (s1o *S1Object) ReadMDAsHTML(path string) (string, error)

func (*S1Object) ReadMDTitle

func (s1o *S1Object) ReadMDTitle(path string) (string, error)

func (*S1Object) Search

func (s1o *S1Object) Search(searchStr string) ([]string, error)