https://github.com/chaoticbyte/plaintext-encyclopedia

A very simple plaintext (and flat-file) browser/encyclopedia/wiki/docs thingy with almost no features
https://github.com/chaoticbyte/plaintext-encyclopedia

docs encyclopedia flat-file golang html-css http-server plaintext web wiki

Last synced: 10 months ago
JSON representation

A very simple plaintext (and flat-file) browser/encyclopedia/wiki/docs thingy with almost no features

• Host: GitHub
• URL: https://github.com/chaoticbyte/plaintext-encyclopedia
• Owner: ChaoticByte
• License: mit
• Created: 2024-08-27T09:52:34.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-07-11T21:20:32.000Z (10 months ago)
• Last Synced: 2025-07-11T21:22:46.568Z (10 months ago)
• Topics: docs, encyclopedia, flat-file, golang, html-css, http-server, plaintext, web, wiki
• Language: Go
• Homepage:
• Size: 687 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Plaintext Encyclopedia

A very simple and clean reader/browser? for plaintext... documentation? wiki? chapters of a book? whatever.

![](./.misc/screenshot1.png)

![](./.misc/screenshot2.png)

## How to use

1. Set your settings in `settings.go`

2. Modify the application (if you want)

3. Compile `go get && go build -o server`

4. Place your `.txt` files into `entries/` (see section "Formatting" below)

5. Run `./server`

6. put behind a proxy (or don't).

### Formatting

The only formatting option you have: to define a title.

```

Title: A title

here comes the entry body ...

```

It has to be defined in the first line of the text file.  

If you don't define a title, the filename without the `.txt` part gets used as the title.

## Requirements

Developed and tested on Linux. Should work on other Unixoids.