跳转到主要内容

基于目录中的静态reST文件和git进行版本控制的轻量级wiki引擎

项目描述

attowiki是一个用于个人使用的非常小巧的wiki引擎。

其主要功能包括

  • 可以在任何目录中启动

  • 使用目录结构中的所有.rst文件作为“wiki”文件

  • 使用git进行版本控制

  • 自动后台保存

  • 旧版本页面的历史查看,包括源代码和diff视图

  • 添加了2个新指令:“todo”和“done”

  • 一些元页面,包括

    • /__index__: 列出所有元页面和常规页面

    • /__cheatsheet__: docutils reStructuredText快捷指南

    • /__todo__: 列出所有页面中找到的todo

    • /__done__: 列出所有页面中找到的done

    • /__xxxxxxx__: 列出所有页面中找到的xxxxxxxxxxxxxx代表任何reStructure 节点,例如所有警告

      • __todo__

      • __done__

      • __attention__

      • __caution__

      • __danger__

      • __error__

      • __hint__

      • __important__

      • __note__

      • __tip__

      • __warning__

      • __admonition__

    • “admonition”元页面仅用于一个页面,使用此类型的url:/文档名称.__admonitionname__

使用方法

启动wiki

$ attowiki

就这些。

attowiki将启动一个小型服务器(默认情况下,服务于https://#:8080

当前目录中的所有.rst文件都将用于wiki

安装

$ pip install attowiki

项目依赖

  • bottle

  • docutils

  • gitpython

版本历史

v0.5.1

  • 错误修正

    • 当PDF生成失败时的错误处理已更改

v0.5

  • 添加了PDF导出按钮

  • 添加了静态文件服务作为后备(并且404仍然作为静态文件的后备 - 当reST文档尝试包含本地文件(如图片)时很有用,这些文件现在由attowiki提供

  • 错误修正

    • 在git仓库的子目录中提供attowiki时,git历史不可用

v0.4

  • 在查看文件旧版本时添加了“查看差异”按钮

  • 在查看文件旧版本时添加了“查看源代码”按钮

  • 添加了文件旧版本的查看历史

  • 添加了__todo__元页面,它扫描所有目录中的todo指令并在一个页面上显示

  • 添加了更通用的__xxxxxxxx__元页面,它扫描所有目录中的xxxxxxx管理指令。这可能适用于任何已注册的节点,特别是警告

    • __todo__

    • __done__

    • __attention__

    • __caution__

    • __danger__

    • __error__

    • __hint__

    • __important__

    • __note__

    • __tip__

    • __warning__

    • __admonition__

  • 添加了仅对单个页面使用“警告”元页面的可能性,使用此类url:/文档名称.__警告名称__

  • 添加了__cheatsheet__元页面,它提供本地的docutils reST速查表

  • 添加了“完成”指令,以便与todo:一起工作,当任务完成时,编辑页面并将“todo”更改为“完成”(它将从__todo__元页面中删除)

  • 移除了iframe

  • 改进了docutils css

  • 一些其他的重构

v0.3

  • 在reST文件中添加了对todo指令的支持(现在正确显示todo)

  • 稍微修改了默认的docutils css

  • 添加了后台保存功能

v0.2

  • 在目录中开始,查找.rst文件并将它们以HTML形式提供服务

  • 首先查找index.rst并提供服务

  • 如果找不到index.rst,则提供包含文件列表的页面

  • 简单编辑(文本区域)。保存和取消按钮

  • 保存时git提交

v0.1

  • 第一个(不工作的)版本

项目详情


下载文件

为您的平台下载文件。如果您不确定要选择哪个,请了解更多关于安装包的信息。

源分发

attowiki-v0.5.1.tar.gz (21.6 kB 查看散列)

上传时间

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面