hub / github.com/JojiiOfficial/ZimWiki
github.com/JojiiOfficial/ZimWiki @v0.0.2
Chat with this repo
90 symbols
229 edges
21 files
64 documented · 71%
● updated 3y agov0.0.2 · 2021-05-26★ 381 open issues
What it actually does AI analysis from the code graph — generated when you open this
loading…
README
ZimServer
A modern zim fileserver which can handle multiple zim files by serving a beautiful Wiki website. It is a lightweight and performant relpacement for kiwix-serve and can handle many big wiki archives (zim files).
Screenshots
| Desktop | Mobile |
|
|
|
|
Installation
- Install go and compile it using
go build -o zimserveror - Download the latest release
Usage
Create a folder library and place your .zim files inside it, or link them using symlinks.
Run the binary and go to https://localhost:8080
Features
- [x] Read/Handle multiple Zim files
- [x] Read Wikis
- [x] Search (inside a wiki or globally)
- [x] Create wiki index files for faster search
- [x] Send content gzipped
- [x] Use symlinks as .zim link
- [x] Replace absolute links with relative ones
- [ ] Config file
Extension points exported contracts — how you extend this code
RouteFunction (FuncType)RouteFunction function for handling a route
router.go
Core symbols most depended-on inside this repo
GetIDcalled by 8
zim/File.go
GetRawWikiURL
called by 6
zim/Entry.go
Write
called by 4
handlers/RespProxy.go
hash
called by 4
zim/search.go
getMethods
called by 3
router.go
RouteHandler
called by 3
router.go
serveTemplate
called by 3
handlers/template.go
GetFiles
called by 3
zim/Handler.go
Shape
Languages
Go98%
TypeScript2%
Modules by API surface
zim/indexDB.go11 symbols
zim/search.go10 symbols
zim/File.go8 symbols
router.go8 symbols
zim/Handler.go7 symbols
handlers/template.go7 symbols
zim/Entry.go5 symbols
main.go5 symbols
handlers/RespProxy.go5 symbols
utils.go4 symbols
handlers/wiki.go4 symbols
zim/indexReader.go3 symbols
For agents
$ claude mcp add ZimWiki \
-- python -m otcore.mcp_server <graph>