Repository files navigation

The table below explains which Django versions are supported.

For upgrade instructions, please refer to theReleaseNotes

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

But please help out by adding more languages!It's very easy, and you don't 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

A demo running the latestmain 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

Please use our IRC or mailing list (google group) to get in touchon development and support. Please do not email developers asking forpersonal support.

• Discussions on GitHub:https://github.com/django-wiki/django-wiki/discussions
• #django-wiki on libera.chat
• django-wiki@googlegroups.com
• Fediverse: @djangowiki@fosstodon.org
• Twitter: @djangowiki

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), usingSemVer versioning schema.

You will need to learn a bit about Django to customize the 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 startsince most customization can be achieved through plugins, templates, and SCSS.

Contributions are welcome! ❤️

Please read ourDeveloper Guide

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

• Be pluggable and lightweight. Don't integrate optional featuresin the core.
• Be open. Make an extension API that allows the ecology of thewiki to grow in a structured way. Wikipedia consists of over1100extension projectswritten for MediaWiki. We should learn from this.
• Be smart.Thisisthe map of tables in MediaWiki - we'll understand the choices ofother wiki projects and make our own. After all, this is a Djangoproject.
• Be simple. The source code shouldalmost explain itself.
• Be structured. Markdown is a simple syntax for readability.Features should be implemented either through easy coding patterns inthe content field, but rather stored in a structured way (in thedatabase) and managed through a friendly interface. This givescontrol back to the website developer, and makes knowledge moreusable. Just ask: Why has Wikipedia never changed? Answer: Becauseits knowledge is stored in a complicated way, thus it becomes verystatic.

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 anissue if you're in doubt about whether something might change.

Django-wiki is a rewrite ofdjango-simplewiki, aproject from 2009 that aimed to be a base system for a wiki. It proposedthat the user should customize the wiki by overwriting templates, butsoon learned that the only customization that really took place was thatpeople forked the entire project. We don't want that for django-wiki, wewant it to be modular and extendable.

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

• Why is the module named justwiki? Because when we triedpip install wiki, it returned "No distributions at all foundfor wiki", so we had to make up for that! ...oh, and django-wiki was occupied.
• What markup language will you use?Markdown. The markuprenderer is not a pluggable part but has been internalized into coreparts. Discussion should go here:#76
• Why not use django-reversion? It's a great project, but if thewiki has to grow ambitious, someone will have to optimize itsbehavior, and using a third-party application for something ascrucial as the revision system is a no-go in this regard.
• Any support for multiple wikis? Yes, in a sense you can justimagine that you always have multiple wikis, because you always havehierarchies and full control of their permissions. See thisdiscussion:#63

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

• The people atedX & MIT for findingand supporting the project both financially and with ideas.
• django-mptt, awonderful utility for inexpensively using tree structures in Djangowith a relational database backend.
• oscarmcm,atombrella,floemker,rsalmaso,spookylukey,jluttine,duvholt,valberg,jdcaballerov,yekibud,bridger,TomLottermann,crazyzubr, andeveryoneelseinvolved!

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