ChaoticByte/plaintext-encyclopedia
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
A very simple plaintext (and flat-file) browser/encyclopedia/wiki/docs thingy with almost no features
This repository has been archived on 2025-09-28. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
20 commits 1 branch 0 tags 733 KiB
Find a file
Exact
ChaoticByte d3d1519f23
Use ids internally and for entry links instead of the full text title
2025-07-11 23:20:27 +02:00
.misc Add site description to home page 2024-08-29 13:30:57 +02:00
entries Require .txt filename extension for entries, allow defining entry title via Title: ... in first line of the file, update examples 2025-07-11 21:32:50 +02:00
public Use ids internally and for entry links instead of the full text title 2025-07-11 23:20:27 +02:00
.gitignore Added a README 2024-08-28 20:29:34 +02:00
database.go Use ids internally and for entry links instead of the full text title 2025-07-11 23:20:27 +02:00
go.mod Add search functionality 2024-08-28 19:49:23 +02:00
go.sum Add search functionality 2024-08-28 19:49:23 +02:00
LICENSE Update LICENSE 2024-08-27 12:00:17 +02:00
main.go Use ids internally and for entry links instead of the full text title 2025-07-11 23:20:27 +02:00
README.md Require .txt filename extension for entries, allow defining entry title via Title: ... in first line of the file, update examples 2025-07-11 21:32:50 +02:00
settings.go Add site description to home page 2024-08-29 13:30:57 +02:00

README.md

Plaintext Encyclopedia

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

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.