ChaoticByte/plaintext-encyclopedia
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added a README

Browse source
This commit is contained in:
ChaoticByte 2024-08-28 20:29:34 +02:00
parent b3ba50ad26
commit 1aa58ac243
No known key found for this signature in database
9 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

4
.gitignore vendored
View file

@ -23,3 +23,7 @@ go.work.sum
# env file # env file
.env .env
# build output
server
plaintext-encyclopedia

BIN
.misc/screenshot1.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 28 KiB

BIN
.misc/screenshot2.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 200 KiB

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# 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 (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.

2
database.go
View file

@ -1,5 +1,7 @@
package main package main
// Copyright (c) 2024 Julian Müller (ChaoticByte)
import ( import (
"io/fs" "io/fs"
"log" "log"

2
main.go
View file

@ -1,5 +1,7 @@
package main package main
// Copyright (c) 2024 Julian Müller (ChaoticByte)
import ( import (
"html/template" "html/template"
"log" "log"

1
public/index.html
View file

@ -1,5 +1,6 @@
<!DOCTYPE html> <!DOCTYPE html>
<html lang="en"> <html lang="en">
<!-- Copyright (c) 2024 Julian Müller (ChaoticByte) -->
<head> <head>
<meta charset="UTF-8"> <meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="viewport" content="width=device-width, initial-scale=1.0">

1
public/static/search.js
View file

@ -1,3 +1,4 @@
// Copyright (c) 2024 Julian Müller (ChaoticByte)
(() => { (() => {
let searchBox = document.getElementById("search-box"); let searchBox = document.getElementById("search-box");
let searchResults = document.getElementById("search-results"); let searchResults = document.getElementById("search-results");

1
public/static/style.css
View file

@ -1,3 +1,4 @@
/* Copyright (c) 2024 Julian Müller (ChaoticByte) */
body { body {
margin: 0; margin: 0;
padding: 0; padding: 0;