liz/wikijs-fork
liz/wikijs-fork
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
435 Commits 1 Branch 0 Tags 31 MiB
Vue 47.7%
JavaScript 42.1%
SCSS 5%
HTML 2%
Shell 1.7%
Other 1.5%
3d9aa18c05
Go to file
NGPixel 3d9aa18c05 refactor: Pre-render TeX + MathML server-side to SVG
2017-07-09 00:01:34 -04:00
.build refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
.github docs: Updated issue template 2017-04-24 22:47:16 -04:00
.vscode feat: 2FA UI + modal 2017-07-09 00:01:34 -04:00
assets feat: updated icons to Nucleo 2017-07-09 00:01:34 -04:00
client refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
npm refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
server refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
test refactor: moved server content to /server 2017-04-28 17:58:38 -04:00
.babelrc Base Project Files 2016-08-16 20:56:55 -04:00
.editorconfig User delete feature 2017-02-10 13:13:40 -05:00
.eslintignore Migrated to Fusebox 2017-03-26 22:07:40 -04:00
.eslintrc.json refactor: editor codeblock -> Vue component 2017-05-28 14:34:50 -04:00
.gitattributes Base Project Files 2016-08-16 20:56:55 -04:00
.gitignore refactor: lazy-load simplemde + minimal lodash 2017-05-27 22:24:46 -04:00
.pug-lintrc.json Fixed pug linting issues 2017-02-09 21:35:37 -05:00
.snyk fix: Updated dependencies + snyk 2017-06-07 22:24:58 -04:00
.travis.yml chore: Excluded docker branch from Travis build 2017-04-30 19:41:20 -04:00
CHANGELOG.md docs: Updated changelog 2017-07-09 00:01:34 -04:00
config.sample.yml refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
docker-compose.yml fix: Removed duplicate pkg + Dockerfile (alpha) 2017-04-28 20:17:10 -04:00
Dockerfile Update Dockerfile 2017-05-23 01:13:38 -03:00
fuse.js refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
LICENSE Initial commit 2016-08-16 15:35:26 -04:00
package.json refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00
README.md docs: updated milestones 2017-07-08 23:09:35 -04:00
tsconfig.json refactor: Upgrade to Fusebox 2.0 2017-05-04 22:41:33 -04:00
wiki.cmd npm install feature 2017-02-14 15:27:08 -05:00
wiki.js refactor: moved server content to /server 2017-04-28 17:58:38 -04:00
yarn.lock refactor: Pre-render TeX + MathML server-side to SVG 2017-07-09 00:01:34 -04:00

README.md

Wiki.js

Release License npm Downloads Chat on Gitter Twitter Follow
Build Status Codacy Badge Dependency Status Standard - JavaScript Style Guide

A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown

Documentation

Requirements

Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).

  • Node.js 6.9.0 or later
  • MongoDB 3.2 or later
  • Git 2.7.4 or later
  • An empty Git repository (optional)

Read the full prerequisites article for full details.

Cloud Install

Deploy to Heroku

Docker, Azure and more coming soon!

Milestones

Current and upcoming milestones (major features only, see the changelog for complete list of features and bug fixes):

Beta 12

Progress

  • Anchor with Copy to clipboard function
  • Full UI Localization
  • Heroku support
  • New Localizations: Chinese, French, Korean, Portuguese, Russian and Spanish
  • Refactor of all client-side code to modular Vue components

Beta 13

Planned for July release
Progress

  • Color Themes
  • Server-side TeX/MathML rendering
  • Render linebreaks by default (Github style)
  • New Localization: German

Beta 14

Planned for August release
Progress

  • History / Revert to previous version
  • Optional Two-Steps Authentication (2FA)
  • Docker support + Auto compile/publish to Docker Hub
  • User Groups + Better permissions management
  • Support sub-directory installations (e.g. example.com/wiki)

Future

  • Insert Link modal in Editor
  • Better simultaneous user editing handling
  • Preview changes directly from the editor, without saving
  • Upgrade from web UI

Gitter

Want to discuss features, ideas or issues? Join our gitter channel. We are very active and friendly!

Twitter

Follow our Twitter feed to learn about upcoming updates and new releases!
Twitter Follow

Translations

We are looking for translators to make Wiki.js available in multiple languages. If your language is not listed below and would like to contribute to this project, contact us on our gitter channel and we'll provide you with the necessary tool to add translations, no coding required!

Languages that are already translated:

Special Thanks

Browserstack
Browserstack for providing access to their great cross-browser testing tools.

DigitalOcean
DigitalOcean for providing hosting of the Wiki.js documentation site.