Code Monkey home page Code Monkey logo

picowiki's Introduction

PicoWiki

PicoWiki is a super tiny and simple file-based Wiki system.

Screenshot of the main page of PicoWiki

Features

  • Markdown Formatting, links, etc.
  • Install in 2 seconds Just place a folder in your server
  • File-based Easily editable
  • Tiny Less than 100 lines of the core code
  • Extensible through Plugins
  • Fast Uses very low bandwidth
  • Powerful You can use PHP code anywhere

Setup

See Setup for instructions.

Plugins

Plugins use Event Hooks to attach new features and alter functionality on the run, a new plugin must have a run() method that will be executed whenever you specify. Check out /backend/plugins/ to find available plugins.

To disable a plugin, simply move it away from the plugins folder (also in a subfolder such as plugins/deactivated).

Hooks

  • init: Initialized the PicoWiki Class, just before loading $config
  • config_loaded: Configuration loaded
  • plugins_loaded: Plugins loaded
  • run_init: Initialized run() method
  • url_loaded: URL parsed
  • list_loaded: File list loaded
  • template_header: Add HTML code before the closing header HTML tag
  • view_after: The file view has been loaded, just before echoing it
  • template_footer: Add HTML code before the closing body HTML tag

License & Contact

© Xavi Esteve. Licensed under MIT.

Parsedown by Emanuil Rusev also licensed under a MIT License.

Contributing

PicoWiki is a single PHP class with 7 methods, all in less than 100 lines of code, ready to be extended. New features I can think of right (through plugins) now are:

  • Report for checking for broken links (links to pages that don't exist yet), Orphan pages, etc.
  • Code snippets to load YouTube videos or Google Maps, etc.
  • Web-based file editor to edit files directly via browser
  • Themes
  • Auto-translate
  • Sitemap generator

If you'd like to contribute please do, I am quite active on Github and usually merge Pull Requests in a few hours or days.

When I say it's tiny I mean this, the whole app is just this code:

Screenshot of the code of PicoWiki where you can see that it is less than 100 lines of code

picowiki's People

Contributors

luckyshot avatar lukasfrydek avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.