Skip to content

felipeng/wikilipe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

84 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WikiLipe

GitHub release

WikiLipe

WikiLipe is a simple personal wiki that uses Markdown syntax.

Instalation

  1. Download or clone this repository into a web server with php module running.
  2. Get access the index.php and the WikiLipe will warn whether adjusting the directory permission is necessary.

For security reasons it is highly recommendable to use .htaccess with authentication for getting the WikiLipe access.

Example:

AuthType Basic
AuthName "WikiLipe"
AuthUserFile /etc/apache2/htpasswd/wikilipe.passwd
Require valid-user
# Allow to access the wikilipe_app.png without authentication
SetEnvIf Request_URI "/wikilipe_app.png$" LogoURI
Order Deny,Allow
Deny from all
Allow from env=LogoURI
Satisfy any

Customization

Syntax Highlight - Languages

The pre built version of highlight.js contains 23 commonly used languages; however, it is possible to create a custom bundle including only the languages you need using this tool

Syntax Highlight - Style

It is also possible to change the syntax highlight's style

Showdownjs - Extensions

It is possible to add more showdown.js' extensions

Components

Development

  1. docker run -p 8080:8080 -v $PWD:/var/www/html trafex/php-nginx
  2. http://localhost:8080

Contributing

If you wish to contribute you can submit an issue or feel free to issue a pull request.

License

WikiLipe is released under the MIT License. See LICENSE file for details.