Welcome to the official repository for the Asok Framework documentation and website. This repository hosts the source code for asok-framework.com, the standard Python library documentation, and all documentation files.
Asok is a Python-first micro-framework with minimal external dependencies, designed for speed, simplicity, and professional web development.
💡 Note for VS Code Users: For the best developer experience, we highly recommend installing the official Asok VS Code Extension. It provides native autocompletion, reactive snippets, and integrated CLI commands directly in your editor.
- 🐍 Python Library Documentation — Standard Sphinx & MyST Python documentation suite.
- 🏠 Official Website — The primary entry point and showcases.
- 📚 Website Docs — Every detail of the framework explained on site.
- 🚀 GitHub Framework — The core framework repository.
This repository is organized into the following parts:
- 📂
python_docs/: Standard Python library documentation (Sphinx, MyST Parser, Furo theme). - 📂
docs/: Source Markdown files used by the website renderer. - 📂
asok-framework.com/: Source code for the official website, built with Asok itself. - 📂
icons/: Visual assets, logos, and brand identity files.
The documentation covers everything you need to master Asok, from your first "Hello World" to complex reactive architectures:
- 🟢 Foundations: Installation, Project Structure, Routing, Request/Response, and Templates.
- 📊 Database & Data: Built-in ORM, Versioned Migrations, Vector Search, and Forms.
- ✨ Reactive UI: Alive Components, WebSockets, Transitions, and HTML Streaming.
- 🛠️ Internal Tools: Admin Interface, API Development, Background Tasks, and Scheduler.
- 🔴 Production & Ops: Security Audit, Deployment, Testing, Logging, and Optimization.
We believe that great documentation is the key to a great framework. If you find a typo, a missing explanation, or have an idea for a new tutorial, your contributions are welcome!
- Fork the repository.
- Create your feature branch (
git checkout -b feature/improved-docs). - Edit the Markdown files in the
docs/directory. - Commit your changes (
git commit -m 'Docs: clarified the ORM relationships section'). - Push to the branch and open a Pull Request.
| Repository | Description |
|---|---|
| asok | The core Python framework engine. |
| asok-vscode | Official VS Code Extension for snippets, highlighting and more. |
| asok-docs | (You are here) Official documentation and website. |
| asok-examples | Production-ready templates and use cases. |
| asok-lab | Experimental features and playground. |
The documentation and the website source code are licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by Mpia M. and the Asok community.