| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Lines of code | 466 |
| Technical Name |
markdown_viewer_locale |
| License | LGPL-3 |
Markdown Viewer Locale
View localized Markdown files based on the user language with integrated search and syntax highlighting
Key Features
Multi-Language Support
Automatic loading of Markdown files according to user language with fallback support
Integrated Search
Built-in content search function with highlighted results for quick information access
Syntax Highlighting
Professional code block rendering with syntax highlighting powered by highlight.js
Usage Methods
Multiple ways to integrate documentation viewer in your Odoo modules
Snippet Template
Method 1
Add a documentation viewer using QWeb snippet template for easy integration
Direct Link
Method 2
Use direct links with data attributes for flexible placement in views
Form Icon
Method 3 (Recommended)
Add documentation icon directly in Odoo forms for quick access
Installation Process
Step 1
Install markdown_viewer_locale module from an Apps menu
Step 2
Create Markdown files in static/src/md/ directory
Step 3
Add viewer to your views using the preferred method
Step 4
Test documentation viewer with different languages
Technical Details
Built with modern libraries and best practices
marked.js
Fast Markdown parser and compiler
MIT Licensehighlight.js
Syntax highlighting for code blocks
BSD LicenseBootstrap 5
Modern responsive design framework
RequiredOdoo 16.0+
Compatible with Odoo 16 and above
RequiredSupported Languages
Works with any language using locale codes
- bg_BG → documentation.bg.md (Bulgarian)
- en_US → documentation.en.md (English)
- de_DE → documentation.de.md (German)
- fr_FR → documentation.fr.md (French)
- es_ES → documentation.es.md (Spanish)
- And any other language using locale code format
Credits
The team behind Markdown Viewer Locale
Odoo Community Association
Project Maintainer
Supporting collaborative development
Want to contribute? Visit our GitHub repository
Please log in to comment on this module