zavy86/wikidocs repository overview

⁠Wiki|Docs

Just a databaseless markdown flat-file wiki.

Project homepage: https://www.wikidocs.app⁠

Please consider supporting this project by making a donation via PayPal⁠.

⁠Features

• Open source
• Plain text files
• No database required
• Markdown syntax
• YAML Frontmatter
• Editor full WYSIWYG
• Support for KaTeX math
• Support for Mermaid diagrams
• Unlimited page revisions
• Uploading and downloading Attachments
• Uploading images (also from clipboard)
• Content can be categorized in namespaces
• Public and private browsing
• Desktop and remote Sync
• Syntax highlighting
• Multi-language
• Dark mode
• and many more...

⁠Demo

Try the demo playground at: http://demo.wikidocs.app⁠

Authentication:

Username: [email protected]
Password: wikidocs

⁠Setup

To run Wiki|Docs you can either use the desktop application or run it in a self-hosted environment.

⁠Desktop

Download⁠ the lastest release of the desktop application and run the installer.

The application will be installed in your system, and you can start it from the start menu or desktop shortcut.

⁠Self-hosted

A Docker image⁠ is available on Docker Hub, which can be used to run Wiki|Docs in a container.

Running in container is the recommended way to self-host Wiki|Docs, as it is the easiest and fastest way to get started.

You can access to the web client at http://localhost:3210 after running the container, and you can also interact with the backend API at http://localhost:3210/api/ where you can find the swagger documentation.

⁠Quick run

docker run -p 3210:3210 zavy86/wikidocs:2

⁠Additional settings

docker run --name wikidocs -d -p 3210:3210 -v /path/to/local/wikidocs/datasets/or/volume:/var/lib/wikidocs zavy86/wikidocs:2

⁠With Docker Compose

Use the following docker-compose.yml file to run Wiki|Docs with Docker Compose:

volumes:
  datasets:

services:
  wikidocs:
    image: zavy86/wikidocs:2
    environment:
      MODE: public|private
      SECRET: generate-a-secret-key-here
    volumes:
      - datasets:/var/lib/wikidocs/datasets
    ports:
      - "3210:3210"

⁠Sync

If you want to sync your Wiki|Docs data between multiple devices, you can self-host the application and configure your desktop application to connect to your self-hosted instance.

In the FILE menu (press ALT on Windows), you can find the Settings menu where you can enter the sync configuration.

This way, you can access and edit your Wiki|Docs content online and from any device.

⁠Developers

Here you can find a list of the contributors that helped to make this project possible.

If you want to contribute to the project, please check the CONTRIBUTING⁠ file for more information.

⁠Creator

💡 Manuel Zavatta⁠ [ Website⁠ | LinkedIn⁠ | YouTube⁠ | Contacts⁠ ]

⁠Collaborators

• Amin Persia⁠
• Paulo Taborda⁠

⁠Contributors

• Alex Meyer⁠
• Micha⁠
• Bo Allen⁠
• Joel Vega⁠
• Sam⁠
• kevwkev⁠
• Сергей Ворон⁠
• Nicolas Prenveille⁠
• Antonio Rodrigues⁠
• Miguel Renato⁠
• Alain Martini⁠
• Davide Visentin⁠
• Christian Weber⁠
• Petr Husák⁠
• Oliver Lehmann⁠
• Prabal Khare⁠

⁠License

Project is licensed under the MIT License⁠.