首页
/ django-wakawaka 技术文档

django-wakawaka 技术文档

2024-12-23 18:20:31作者:卓炯娓

1. 安装指南

1.1 环境要求

  • Python 3.8 及以上版本
  • Django 3.2 (LTS) 及以上版本

1.2 安装步骤

  1. 使用 pip 安装 django-wakawaka

    pip install django-wakawaka
    
  2. 在 Django 项目的 settings.py 文件中,将 wakawaka 添加到 INSTALLED_APPS 列表中:

    INSTALLED_APPS = [
        ...
        'wakawaka',
        ...
    ]
    
  3. urls.py 文件中,添加 wakawaka 的 URL 配置:

    from django.urls import include, path
    
    urlpatterns = [
        ...
        path('wiki/', include('wakawaka.urls')),
        ...
    ]
    

2. 项目的使用说明

2.1 基本功能

  • 自动链接解析:Wiki 页面之间的链接通过 CamelCase 命名方案自动解析。
  • 版本控制:自动跟踪页面的修订历史,并提供回滚到早期版本的功能。
  • 权限管理:与 Django 的默认权限系统集成,支持创建、编辑和删除 Wiki 页面的权限。

2.2 示例项目

项目附带一个示例项目,展示了 Wiki 的主要功能,并帮助用户将应用程序集成到现有项目中。可以通过以下步骤运行示例项目:

  1. 安装 Poetry:

    pip install poetry
    
  2. 安装项目依赖:

    poetry install
    
  3. 运行数据库迁移:

    poetry run ./manage.py migrate
    
  4. 创建超级用户:

    poetry run ./manage.py createsuperuser
    
  5. 启动开发服务器:

    poetry run ./manage.py runserver
    

3. 项目API使用文档

3.1 权限管理

Wakawaka 与 Django 的权限系统集成,用户需要具备相应的权限才能执行以下操作:

  • 创建 Wiki 页面:需要 add_wikipage 权限。
  • 编辑 Wiki 页面:需要 change_wikipage 权限。
  • 删除 Wiki 页面:需要 delete_wikipage 权限。

3.2 自定义设置

  • 默认首页名称:可以通过 WAKAWAKA_DEFAULT_INDEX 设置自定义默认首页名称。例如:

    WAKAWAKA_DEFAULT_INDEX = 'Home'
    
  • CamelCase 链接规则:可以通过 WAKAWAKA_SLUG_REGEX 设置自定义的 CamelCase 链接规则。默认规则为:

    WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'
    

4. 项目安装方式

4.1 通过 pip 安装

pip install django-wakawaka

4.2 通过 Poetry 安装

  1. 安装 Poetry:

    pip install poetry
    
  2. 安装项目依赖:

    poetry install
    
  3. 运行测试:

    poetry run pytest
    

通过以上步骤,您可以顺利安装并使用 django-wakawaka 项目。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
162
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
96
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
Git4ResearchGit4Research
Git4Research旨在构建一个开放、包容、协作的研究社区,让更多人能够参与到科学研究中,共同推动知识的进步。
HTML
22
1
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
950
557
risc-v64-naruto-pirisc-v64-naruto-pi
基于QEMU构建的RISC-V64 SOC,支持Linux,baremetal, RTOS等,适合用来学习Linux,后续还会添加大量的controller,实现无需实体开发板,即可学习Linux和RISC-V架构
C
19
5