Giter Club home page Giter Club logo

attowiki's Introduction

attowiki

attowiki is a very small wiki engine for personal use.

Its main features are:

  • can be started in any directory
  • uses all .rst files in directory structure as "wiki" files
  • uses git for revision control
  • automatic background saving
  • pdf generation
  • history view of old version of pages, including source and diff views
  • added 2 new directives: 'todo' and 'done'
  • some meta pages, including:
    • /__index__: gives a list of all meta pages and normal pages
    • /__cheatsheet__: docutils reStructuredText cheat sheet
    • /__todo__: gives a list of all todo found in all pages
    • /__done__: gives a list of all done found in all pages
    • /__xxxxxxx__: gives a list of all xxxxxxx found in all pages, xxxxxxx represent any reStructure node, like all admonitions:
      • __todo__
      • __done__
      • __attention__
      • __caution__
      • __danger__
      • __error__
      • __hint__
      • __important__
      • __note__
      • __tip__
      • __warning__
      • __admonition__
    • "admonition" meta pages for one page only using this kind of url: /name of the doc.__admonitionname__

usage

Launching a wiki

$ attowiki

that's all.

attowiki will start a small server (by default, serving to http://localhost:8080)

all the .rst files inside the current directory will be used for the wiki

installation

$ pip install attowiki

project dependencies

  • bottle
  • docutils
  • gitpython
  • rst2pdf

attowiki's People

Contributors

thomaschiroux avatar fnd avatar

Watchers

Jörg avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.