django-wiki logo

django-wiki

  •  0 ratings
In category: Wikis

About django-wiki

Wiki system with complex functionality for simple integration and a superb interface. Store your knowledge with style: Use django models.

  •   546  
  •   0  
  •   0  
  •   0  
Github stats:
  •  Commits: N/A  
  •   N/A  
  •   N/A  
  •  Latest commit: N/A  

Deploy this app to Linode with a free $100 credit!

Languages/Platforms/Technologies:
Lincenses:

More about django-wiki

django-wiki

For upgrade instructions, please refer to the Release Notes <https://django-wiki.readthedocs.io/en/latest/release_notes.html>__

Translations (Transifex)

Django-wiki is fully translated into 13 languages, apart from the default (English) and some additional languages underway.

But please help out in adding more languages! It's very easy and you don't even need to be a programmer.

Some languages...

  • ...just need a little push, as they are almost fully complete
  • ...got initiated and need a new instigator to carry on the ambitions
  • ...do not exist yet - but you can request them and become the coordinator

Visit the django-wiki project on Transifex <https://www.transifex.com/django-wiki/django-wiki/>__

Demo

A demo running the latest main branch is available here:

https://demo.django-wiki.org

Sign up for an account to see the notification system, or you can log in with the existing account:

  • user: admin
  • password:admin

Community

Please use our IRC or mailing list (google group) for getting in touch on development and support. Please do not email developers asking for personal support.

  • Discussions on GitHub: <https://github.com/django-wiki/django-wiki/discussions>__
  • #django-wiki on libera.chat <https://web.libera.chat/?channel=#django-wiki>__
  • django-wiki@googlegroups.com <https://groups.google.com/forum/#!forum/django-wiki>__
  • twitter:djangowiki <https://twitter.com/djangowiki>__

Always a work in progr...

On a number of factors, this project has proven itself useful and stable.

  • There won't be changes that are expected to cause loss of data without a proper upgrade path.
  • The model API has been very stable and is only subject to smaller changes.
  • The plugin API seems pretty stable.
  • You can maintain the latest version of django-wiki through PyPi (package name: wiki), using SemVer <https://semver.org/>__ versioning schema.

What should I customize? What can break? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You will need to learn a bit of Django to customize django-wiki.

The simplest is to override templates and create your own template tags. Do not make your own hard copy of this repository in order to fiddle with internal parts of the wiki, this strategy will lead you to lose out on future updates with highly improved features, plugins and security fixes.

You can also override the whole Bootstrap theming. At present, you're best off maintaining your own Bootstrap SCSS and hard-copying, then overriding django-wiki's rules.

All Python views are class-based. However for most cases overriding views and URLs shouldn't be the best place to start since most customization can be achieved through plugins, templates and SCSS.

Contributing

Contributions are welcome! ❤️

Please read our Developer Guide <https://django-wiki.readthedocs.io/en/latest/development/index.html>__

Manifesto

Django needs a mature wiki system appealing to all kinds of needs, both big and small:

  • Be pluggable and light-weight. Don't integrate optional features in the core.
  • Be open. Make an extension API that allows the ecology of the wiki to grow in a structured way. Wikipedia consists of over 1100 extension projects <https://phabricator.wikimedia.org/diffusion/query/all/?after=1100>__ written for MediaWiki. We should learn from this.
  • Be smart. This is <https://upload.wikimedia.org/wikipedia/commons/f/f7/MediaWiki_1.24.1_database_schema.svg>__ the map of tables in MediaWiki - we'll understand the choices of other wiki projects and make our own. After-all, this is a Django project.
  • Be simple. The source code should almost explain itself.
  • Be structured. Markdown is a simple syntax for readability. Features should be implemented either through easy coding patterns in the content field, but rather stored in a structured way (in the database) and managed through a friendly interface. This gives control back to the website developer, and makes knowledge more usable. Just ask: Why has Wikipedia never changed? Answer: Because it's knowledge is stored in a complicated way, thus it becomes very static.

Docs

See the docs/ folder, or read them at:

https://django-wiki.readthedocs.io/en/latest/

If you wish to add something, please ask in the google group or raise an issue if you're in doubt about whether something might change.

Background

Django-wiki is a rewrite of django-simplewiki <https://code.google.com/p/django-simple-wiki/>__, a project from 2009 that aimed to be a base system for a wiki. It proposed that the user should customize the wiki by overwriting templates, but soon learned that the only customization that really took place was that people forked the entire project. We don't want that for django-wiki, we want it to be modular and extendable.

As of now, Django has existed for too long without a proper wiki application. The dream of django-wiki is to become a contestant alongside Mediawiki, so that Django developers can stick to the Django platform even when facing tough challenges such as implementing a wiki.

Q&A

  • Why is the module named just wiki ? Because when we tried pip install wiki, it returned "No distributions at all found for wiki", so we had to make up for that! ...oh, and django-wiki was occupied.
  • What markup language will you use? Markdown <https://pypi.python.org/pypi/Markdown>__. The markup renderer is not a pluggable part but has been internalized into core parts. Discussion should go here: https://github.com/django-wiki/django-wiki/issues/76
  • Why not use django-reversion? It's a great project, but if the wiki has to grow ambitious, someone will have to optimize its behavior, and using a third-party application for something as crucial as the revision system is a no-go in this regard.
  • Any support for multiple wikis? Yes, in an sense you can just imagine that you always have multiple wikis, because you always have hierarchies and full control of their permissions. See this discussion: https://github.com/django-wiki/django-wiki/issues/63

Docker tl;dr

There is a docker container available here: https://github.com/riotkit-org/docker-django-wiki

Acknowledgements

  • The people at edX <https://www.edx.org/>__ & MIT for finding and supporting the project both financially and with ideas.
  • django-mptt <https://github.com/django-mptt/django-mptt>__, a wonderful utility for inexpensively using tree structures in Django with a relational database backend.
  • oscarmcm <https://github.com/oscarmcm>, atombrella <https://github.com/atombrella>, floemker <https://github.com/floemker>, rsalmaso <https://github.com/rsalmaso>, spookylukey <https://github.com/spookylukey>, jluttine <https://github.com/jluttine>, duvholt <https://github.com/duvholt>, valberg <https://github.com/valberg>, jdcaballerov <https://github.com/jdcaballerov>, yekibud <https://github.com/yekibud>, bridger <https://github.com/bridger>, TomLottermann <https://github.com/TomLottermann>, crazyzubr <https://github.com/crazyzubr>, and everyone else <https://github.com/django-wiki/django-wiki/graphs/contributors> involved!

Original source of inspiration back in 2009 was django-cms, and since then Wagtail has also done a tremendous amount of work to promote Django models as a fundamental structure and enabler for application design.

Comments (0)

Please login to join the discussion on this project.

django-wiki Reviews (0)

Overall Rating

None

based on 0 ratings

Please login to review this project.

No reviews for this project yet.

↑ back to top

pCloud Lifetime

Popular Projects

FluxBB

in Social Networks and Forums
 33k    0    0    0  

Nextcloud

in File Transfer & Synchronization
 20k    1    1    0  

Libreddit

in Social Networks and Forums
 7k    0    1    0  

Dashboard

in Personal Dashboards
 6k    0    0    0  

Audiobookshelf

in Audio Streaming
 6k    0    1    0  

CasaOS

in Self-hosting Solutions
 5k    0    0    0  

Mediagoblin

in Photo and Video Galleries
 4k    0    0    0  

Most Discussed

Nextcloud

in File Transfer & Synchronization
 20k    1    1    0  

Tube Archivist

in Automation
 3k    0    1    0  

OneDev

in Project Management
 2k    0    0    0  

iodine

in Proxy
 2k    0    0    0  

Alf.io

in Booking and Scheduling
 2k    0    0    0  

sysPass

in Password Managers
 1k    0    0    0  

Misskey

in Social Networks and Forums
 2k    0    0    0  
Linux VPS from $11/yr.
RackNerd VPS for $11.38/mo

Top Rated Projects

Gitea

 1 rating
in Project Management

Bagisto

 1 rating
in E-commerce

LinkAce

 1 rating
in Bookmarks and Link Sharing

Pydio

 1 rating
in File Transfer & Synchronization

Audiobookshelf

 1 rating
in Audio Streaming

Nextcloud

 1 rating
in File Transfer & Synchronization

Seafile

 1 rating
in File Transfer & Synchronization

Categories

You May Also Be Interested In

Raneto logo
Raneto cover

Raneto

Raneto is an open source Knowledgebase platform that uses s…

Gitit logo
Gitit cover

Gitit

Wiki program that stores pages and uploaded files in a git …

Gollum logo
Gollum cover

Gollum

Simple, Git-powered wiki with a sweet API and local fronten…