https://github.com/vito/booklit

a pretty lit content authoring system
https://github.com/vito/booklit

booklit cms documentation-tool go static-site-generator

Last synced: 1 day ago
JSON representation

a pretty lit content authoring system

• Host: GitHub
• URL: https://github.com/vito/booklit
• Owner: vito
• License: mit
• Created: 2017-06-29T05:01:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-06-12T22:57:23.000Z (6 months ago)
• Last Synced: 2024-10-14T19:38:52.596Z (about 2 months ago)
• Topics: booklit, cms, documentation-tool, go, static-site-generator
• Language: Go
• Homepage: https://booklit.page
• Size: 9.19 MB
• Stars: 175
• Watchers: 9
• Forks: 55
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-repositories - vito/booklit - a pretty lit content authoring system (Go)

README

        
# booklit

[![Go Reference](https://pkg.go.dev/badge/github.com/vito/booklit.svg)](https://pkg.go.dev/github.com/vito/booklit)

Booklit is a tool for building static websites from semantic documents.

## documentation

[booklit.page](https://booklit.page)

## installation

grab the latest [release](https://github.com/vito/booklit/releases), or build

from source:

```bash

go get github.com/vito/booklit/cmd/booklit

go install github.com/vito/booklit/cmd/booklit

```

## usage

```bash

booklit -i foo.lit -o ./out

```

## example

clone this repo and build the Booklit website:

```bash

./scripts/build-docs

```

then browse the generated docs from `./docs/index.html`.

alternatively, run the docs in server mode:

```bash

./scripts/build-docs -s 3000

```

...and then browse to [localhost:3000](https://localhost:3000)