Skip to main content

WiKo: The wiki compiler, a static site and pdf generator.

Project description

Wiko, the Wiki Compiler

By David Garcia and Pau Arumi

Description

We do not recommended to use Wiko in new projects. This is a quite deprecated zombie project from 2007. It is kept alive because it is still being used to generate some websites pending to be migrated to modern static generators.

WiKo is a very simple but powerful python script which takes files with wiki content in a given directory and either builds a web, a LaTeX article or a blog. It is very recommended to use it in tandem with a collaborative versioning systems in order to publish on commit.

Main benefits of using WiKo are:

  • An easy and readable wiki like format that generates LaTeX and HTML indistinctly
  • You can use your favourite text editor instead web forms to edit content
  • You don't need to reformat content to reuse it from the web to a LaTeX article or to a blog.
  • You can change the look of your entire site by changing common headers, side bars, footers and styling in a pair of files which are content independent. And still it is an static web site.
  • You can put your web site or your article under a versioning system (cvs, svn...) for collaborative elaboration and having a published version that updates on commit.

Installation

pip install wiko

System dependencies

  • python-bibtex: Optional. For nicer HTML bibliography.
  • mimetex: Optional. Alternative to avoid relying on external services for formulae in HTML output.

Features

Common formatting

  • Text formating: '''bold''', ''italics''...
  • Hypertext and anchoring: [[http://lalala.com links]] and the like
  • Lists and enumerations
  • Table of content generation for HTML pages
  • LaTeX constructs supported on both formats: figures, formulae, bibliography, footnotes...
  • Automatic recompilation of some image formats (dia->eps/png, dot->eps/png, eps->pdf...)
  • User definable paragraphs types
  • Useful constructs for elaboration such as to-do notes and reviewers notes
  • Gallery generation

Blogging

The blog mode takes the wiki files as blog entries and combines and distributes them in different pages and RSS's according to attributes you can define for each entry such as publication date, author, tags...

  • a front page with newer entries,
  • RSS file with the last entries
  • filtered pages with entries by the same author or with a given tag,
  • graphical import tool from Blogger and Wordpress
  • objects for the sidebar with archived entries and tags list

Authors

This script has been developed mainly by ''David Garcia Garzon'' and ''Pau Arumi Albo''. They developed the script for their own personal use on their webs, scientific articles and even their thesis. See at the WiKo examples page.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wiko-1.0.0.tar.gz (24.0 kB view details)

Uploaded Source

Built Distribution

wiko-1.0.0-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file wiko-1.0.0.tar.gz.

File metadata

  • Download URL: wiko-1.0.0.tar.gz
  • Upload date:
  • Size: 24.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for wiko-1.0.0.tar.gz
Algorithm Hash digest
SHA256 bf4f0f03d1a63872def0f27bf416b5b2c3ff8c45af24920def691c77079a9ba5
MD5 ff6864a88aaec4aacee96c899780245c
BLAKE2b-256 d470d50180a62b0fd781277aedf54a1e3b1ba52d2a7e7b523ba03dd04aa0c9c0

See more details on using hashes here.

File details

Details for the file wiko-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: wiko-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 23.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 colorama/0.4.4 importlib-metadata/4.6.4 keyring/23.5.0 pkginfo/1.8.2 readme-renderer/34.0 requests-toolbelt/0.9.1 requests/2.25.1 rfc3986/1.5.0 tqdm/4.57.0 urllib3/1.26.5 CPython/3.10.6

File hashes

Hashes for wiko-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6eda859035d04da3ba6276af55dbcb886b80eacb0ea8181f7369a7691b213a7
MD5 b4f1d3f55e4331af7be39b6b9371ce43
BLAKE2b-256 fbf1350bc73e54ff0b0964db4a8fa811c4c7294f4695888dcaf202f06af75f3c

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page