diff --git a/.gitignore b/.gitignore index 6f72f89..dd5f407 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,7 @@ go.work.sum # env file .env + +# build output +server +plaintext-encyclopedia diff --git a/.misc/screenshot1.png b/.misc/screenshot1.png new file mode 100644 index 0000000..3171d5b Binary files /dev/null and b/.misc/screenshot1.png differ diff --git a/.misc/screenshot2.png b/.misc/screenshot2.png new file mode 100644 index 0000000..5a45b0f Binary files /dev/null and b/.misc/screenshot2.png differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..202e97d --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# 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. diff --git a/database.go b/database.go index 3b347b5..c153c30 100644 --- a/database.go +++ b/database.go @@ -1,5 +1,7 @@ package main +// Copyright (c) 2024 Julian Müller (ChaoticByte) + import ( "io/fs" "log" diff --git a/main.go b/main.go index 368deb4..9d822b8 100644 --- a/main.go +++ b/main.go @@ -1,5 +1,7 @@ package main +// Copyright (c) 2024 Julian Müller (ChaoticByte) + import ( "html/template" "log" diff --git a/public/index.html b/public/index.html index 3c3ede4..731a9dd 100644 --- a/public/index.html +++ b/public/index.html @@ -1,5 +1,6 @@ +
diff --git a/public/static/search.js b/public/static/search.js index 7c089ea..ca77feb 100644 --- a/public/static/search.js +++ b/public/static/search.js @@ -1,3 +1,4 @@ +// Copyright (c) 2024 Julian Müller (ChaoticByte) (() => { let searchBox = document.getElementById("search-box"); let searchResults = document.getElementById("search-results"); diff --git a/public/static/style.css b/public/static/style.css index a57e3f5..bc06cbe 100644 --- a/public/static/style.css +++ b/public/static/style.css @@ -1,3 +1,4 @@ +/* Copyright (c) 2024 Julian Müller (ChaoticByte) */ body { margin: 0; padding: 0;