godmoonl / openNAMU

Python-based wiki engine.

openNAMU

openNAMU is a Python-based wiki engine. You can use openNAMU by installing Python and its dependency modules, and you can modify the code yourself to create more specialized wikis.

• (README for Korean)

Index

• Getting Started
• Clone
• Contribute
• License
• Authors
• Etc.

Getting Started

openNAMU is based upon Python, and it requires a Python environment.

Set-Ups

Install Python

See Python Installation Guide(KR).

Download Releases

Download the release version of openNAMU, and unzip the file. It is also possible to download releases by cloning this repository.

Install Modules

Windows

pip install -r requirements.txt

Linux

pip3 install -r requirements.txt

Launching Application

Windows

python app.py

Linux

python3 app.py

Publishing Application

Clone

You can clone this repository by entering the following command at the terminal (command prompt):

Stable

• git clone -b stable https://github.com/2du/openNAMU.git

Beta

• git clone -b master https://github.com/2du/openNAMU.git

Contribute

openNAMU may have some untested bugs. Your use of openNAMU and bug discovery will help develop openNAMU. Create Issues

openNAMU is open source project. Add new features and request pull requests. Create Pull Requests

Lisence

openNAMU is protected by BSD 3-Clause License. Please refer to the documentation for details.

External Projects

• Quotes icon Dave Gandy
• Syntax highlighting highlightjs
• Numerical expression MathJax
• Handling Keyboard Shortcuts shortcut.js

Authors

• Reference

Special Thanks

• Team Croatia
• Basix
• Efrit
• Other chat rooms

Etc.

• Owner rights are granted to the first registor.