About

Bindle wiki is a compact, file-backed wiki designed for personal projects and small teams. It favors simplicity, low operational overhead, and a straightforward Markdown workflow: authors edit Markdown source files and the application renders them to static HTML for fast serving.

Key characteristics

Stack: Python 3, Flask, Jinja2 templates. The app is intended to run behind uWSGI (example_uwsgi.ini) or the Flask development server for local use.
Storage: Markdown sources live in pages_md/; rendered HTML is written to pages/ so pages can be served efficiently by the web server. Per-page metadata and change history are stored under pages_meta/.
Markdown: Uses Python-Markdown (preferred) with extra/toc extensions and falls back to mistune or markdown2 when necessary. The renderer supports images, code blocks, and basic TOC generation.
Navigation: Each page gets a generated table-of-contents (h2-h4_by_default) and smooth in-page scrolling. The Home page includes an index of available pages (About_is_excluded).
Authentication: Optional LDAP/LDAPS authentication with service-bind support and an admins group for elevated privileges. Admins can bulk-delete pages and edit the Home page from the admin UI.
UX: Light/dark themes, responsive layout, Prism.js syntax highlighting with copy-to-clipboard for code blocks, and a small footer linking to this About page.
API: A lightweight JSON API at /api/pages exposes the list of pages and page content for integrations or scripts.
History & metadata: The app records a per-page "last modified" timestamp and the user who made the change, and keeps a simple change history in pages_meta/<page>.history.json for auditing.
Configuration: Centralized in config.py (or_environment_variables) — LDAP settings, session lifetime, and other options live there.

Development & deployment notes

To run locally: create and activate a virtualenv, pip install -r requirements.txt, then run with Flask or uWSGI as shown in the project README.md.
For production: run uWSGI behind a reverse proxy (nginx) and ensure a secure SECRET_KEY and properly installed dependencies (e.g.,_ldap3_if_using_LDAP).
Backups: Because pages are stored as files, backing up the pages_md/, pages/, and pages_meta/ directories is sufficient to preserve content and history.

License

This project is licensed under the GNU General Public License version 3 (GPLv3).

The full text of the GNU General Public License v3 is included in the repository as the LICENSE file.

You may redistribute and/or modify this program under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at_your_option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

For the complete license text, see LICENSE.