Skip to content

empress-eco/wiki

 
 

Repository files navigation

Logo

Empress Wiki: Next-Generation Knowledge Management

A dynamic, open-source application designed to revolutionize the creation, administration, and delivery of knowledge-based content.
Explore the Docs · Report Bug · Request Feature

About The Project

📖 Overview

Empress Wiki is an innovative, open-source application designed to handle dynamic, text-intensive content such as documentation and knowledge bases. Equipped with a change approval mechanism and the capability to publish changes and new pages without downtime, it's the perfect tool for all your knowledge management needs.

🌟 Key Features

  • Create and manage Wiki Pages effortlessly
  • Author content in Rich Text for a superior user experience
  • Enjoy seamless control over Wiki Updates
  • Attach files with ease
  • Automatic Table of Contents generation
  • Optimize performance with caching
  • Custom Script Support via Wiki Settings

🛠 Built With

Empress Wiki is powered by the following major frameworks/libraries:

Getting Started

Prerequisites

Ensure you have Framework v14 or above installed on your machine.

Installation

Use these steps to get Empress Wiki up and running on your system:

# clone the repository
$ git clone https://github.com/empress-eco/wiki.git

# get app
$ bench get-app wiki

# install on site
$ bench --site sitename install-app wiki

Note

Use version-14 branch with Framework v14 and for v14+, use the master branch.

Usage

Check out the 'Docs' section for detailed instructions on how to use the various features of Empress Wiki. For a visual guide, refer to the screenshots provided.

Contributing

We appreciate contributions! Here's how you can contribute:

  • Fork the Project
  • Create your Feature Branch (git checkout -b feature/AmazingFeature)
  • Commit your Changes (git commit -m 'Add some AmazingFeature')
  • Push to the Branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

License and Acknowledgements

License

This project is licensed under the MIT License, and your contributions will also be licensed under the same.

Acknowledgements

  • Our gratitude goes out to the Empress Community, whose groundbreaking work on essential tools has made this project possible.
  • A big thank you to all the contributors who have helped this project grow.

About

Free and Open Source Wiki built on top of Frappe

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 31.8%
  • JavaScript 28.3%
  • HTML 23.2%
  • SCSS 16.7%