How redimp/otterwiki works
An Otter Wiki is a Flask-based collaborative Markdown wiki whose pages and attachments are versioned in Git. Users browse, edit, and manage pages through web views; the server routes requests into wiki, rendering, authentication, and storage logic, while the browser editor supplies Markdown-oriented editing and attachment upload. The README also documents page history, customizable sidebar/index, extended Markdown, and experimental Git HTTP access. Several of those subsystems are represented by their exact source paths but were not sampled, so their internal links are omitted rather than inferred.
Main entry points: views.py Web views · server.py Flask server · renderer.py Markdown renderer · wiki.py Page operations
Components 22
Web application
- Flask server
otterwiki/server.py - Web views
otterwiki/views.py
Wiki content
- Page operations
otterwiki/wiki.py - Git storage
otterwiki/gitstorage.py - Markdown renderer
otterwiki/renderer.py - Page index
otterwiki/pageindex.py - Sidebar
otterwiki/sidebar.py - Backlinks
otterwiki/backlinks.py - Sitemap
otterwiki/sitemap.py
Browser editor
- CodeMirror editor
frontend/src/index.js - Markdown formatting
frontend/src/editor-formatting.js - Editor state helpers
frontend/src/helpers.js - Inline attachments
frontend/src/inline-attachment.js
Extensions and integrations
- Plugin system
otterwiki/plugins.py - Markdown embeddings
otterwiki/renderer_embeddings.py - Renderer plugins
otterwiki/renderer_plugins.py - Repository management
otterwiki/repomgmt.py - Git HTTP access
otterwiki/remote.py
Identity and settings
- Authentication
otterwiki/auth.py - Database models
otterwiki/models.py - Preferences
otterwiki/preferences.py
Other components
- Wiki user
Connections 23
- Wiki user → Flask server: uses wiki
- Flask server → Web views: registers routes
otterwiki/server.py - Web views → Page operations: handles page requests
otterwiki/views.py - Web views → Authentication: checks identity
otterwiki/views.py - Authentication → Database models: queries users
otterwiki/auth.py - Page operations → Git storage: reads and writes
otterwiki/wiki.py - Web views → Markdown renderer: renders pages
otterwiki/views.py - Markdown renderer → Plugin system: uses hooks
otterwiki/renderer.py - Markdown renderer → Renderer plugins: delegates rendering
otterwiki/renderer.py - Markdown renderer → Markdown embeddings: renders embeddings
otterwiki/renderer_embeddings.py - Web views → Page index: builds page index
otterwiki/views.py - Web views → Sidebar: renders sidebar
otterwiki/views.py - Page operations → Backlinks: uses backlinks
otterwiki/wiki.py - Web views → Sitemap: serves sitemap
otterwiki/views.py - Flask server → Plugin system: sets up plugins
otterwiki/server.py - Web views → Preferences: manages preferences
otterwiki/views.py - Wiki user → CodeMirror editor: edits Markdown
- CodeMirror editor → Markdown formatting: installs commands
frontend/src/index.js - Markdown formatting → Editor state helpers: updates document
frontend/src/editor-formatting.js - CodeMirror editor → Inline attachments: enables uploads
frontend/src/index.js - Wiki user → Git HTTP access: clones or pushes
- Web views → Repository management: manages repository
otterwiki/views.py - Flask server → Git storage: initializes storage
otterwiki/server.py