WikiTS

A modern yet configurable and lightweight wiki
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

WikiTS is a simple declarative way of writing wikis. It features a modern looking yet simple frontend coupled with basic api. WikiTS also comes with a tool helping you convert existing markdown into a WikiTS compatible format. Alternatively you can write the declarations in either json or yaml

Getting Started

Prerequisites

All you need is docker and docker-compose Or if you don't want to use those you need the following dependencies:

• Node
• NPM
• Typescript
• Angular cli

If you wish to generate the wiki data or convert existing data you need the following:

• Python3
• PyYAML

Installation

Installation without docker

1. Clone the wikiTS

git clone https://github.com/F0xedb/wikiTS.git

2. Build the declaration file

python -m generator -j -i yamlfile
# or with a yaml directory
python -m generator -j -i yamldir

3. move declaration file to the right location

mv declaration.json api/

4. Install api dependencies

cd api
npm install

5. Compile api

tsc server.ts

6. Launch api

node server.js

7. Install angular dependencies

cd wiki
npm install

8. Build angular application

ng build

The angular application can now be deployed on a webserver. The files to serve are located in wiki/dist/wiki

Installation with docker

1. Generate compiled files

# wait for everything to complete
docker-compose -f docker-compose-generate up

2. Deploy application

docker-compose up
# Alternatively a traefik V2 example is provided
docker-compose -f docker-compose-traefik.yaml up

Don't forget to change all environment settings. Each file you must edit is shown below:

• api/environment.ts
• wiki/src/environment/environment.ts

Make sure you point all domains to your instance eg localhost or your domain.

Usage

You should visit the wikiTS page if you want to see how to use it.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

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

License

Distributed under the MIT License. See LICENSE for more information.

Contact

F0xedb - tom@odex.be

Project Link: https://github.com/F0xedb/wikiTS

Acknowledgements

• F0xedb