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.
14 commits 1 branch 0 tags 733 KiB
Find a file
ChaoticByte 1aa58ac243
Added a README
2024-08-28 20:29:34 +02:00
.misc Added a README 2024-08-28 20:29:34 +02:00
entries Updated example entries 2024-08-27 13:34:27 +02:00
public Added a README 2024-08-28 20:29:34 +02:00
.gitignore Added a README 2024-08-28 20:29:34 +02:00
database.go Added a README 2024-08-28 20:29:34 +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 Added a README 2024-08-28 20:29:34 +02:00
README.md Added a README 2024-08-28 20:29:34 +02:00
settings.go Add search functionality 2024-08-28 19:49:23 +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 (if you want)
  3. Compile go get && go build -o server
  4. Place your content into entries/
  5. Run ./server
  6. put behind a proxy (or don't).

Requirements

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