mirror of
https://github.com/Django-LiveView/docs.git
synced 2025-11-25 06:05:17 +01:00
Update documentation to Django LiveView v2.0.0
- Complete rewrite of documentation for v2.0.0 API - Updated from old actions/ structure to new @liveview_handler decorator - Renamed Tutorials to Tutorial with inline content - Added emojis to navigation and homepage - Updated footer: removed Jabber/XMPP, 3-column layout on desktop - Updated header: Source code links to GitHub - All content translated to English - Updated hero subtitle and README - Removed Demo button from navigation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
42
README.md
42
README.md
@@ -1,27 +1,39 @@
|
||||
# Website and documentation
|
||||
# Django LiveView Website and Documentation
|
||||
|
||||
This repository contains the source code for the website and documentation of Django Liveview.
|
||||
This repository contains the source code for the website and documentation of Django LiveView v2.0.0.
|
||||
|
||||
It is a static website generated with [one.el](https://one.tonyaldon.com/).
|
||||
|
||||
## Do you want to contribute?
|
||||
## Contributing
|
||||
|
||||
Edit `one.org`. It is a org file that contains the documentation and text of the website.
|
||||
Edit `one.org` - an Org mode file that contains all the documentation and website content.
|
||||
|
||||
## Do you want to build the website?
|
||||
## Building the Website
|
||||
|
||||
Install Emacs in your system.
|
||||
|
||||
After that, you must install the `one.el` package.
|
||||
### Using Docker (Recommended)
|
||||
|
||||
```bash
|
||||
M-x package-install RET one.el RET
|
||||
```
|
||||
|
||||
Then, open `one.el` and run the following command:
|
||||
|
||||
```bash
|
||||
M-x one-build
|
||||
docker compose up one-el
|
||||
```
|
||||
|
||||
The website will be generated in the `public` directory.
|
||||
|
||||
### Local Build
|
||||
|
||||
1. Install Emacs in your system
|
||||
2. Install the `one.el` package:
|
||||
```
|
||||
M-x package-install RET one.el RET
|
||||
```
|
||||
3. Open `one.org` in Emacs
|
||||
4. Run: `M-x one-build`
|
||||
|
||||
The website will be generated in the `public` directory.
|
||||
|
||||
## Serving Locally
|
||||
|
||||
```bash
|
||||
docker compose up nginx
|
||||
```
|
||||
|
||||
Then visit http://localhost:9100
|
||||
|
||||
Reference in New Issue
Block a user