msb-public
/
wiki
mirror of https://github.com/requarks/wiki
1
0
Code Issues Projects Releases Wiki Activity
Wiki.js | A modern and powerful wiki app built on Node.js
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
420 Commits
3 Branches
118 Tags
72 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '8c828790dc'
${ noResults }
Go to file
Nicolas Giard 8c828790dc
Update README.md 		7 years ago
.build refactor: editor codeblock -> Vue component 7 years ago
.github docs: Updated issue template 7 years ago
.vscode refactor: Removed old client page logic 7 years ago
assets chore: Updated manifest + added glimpse in debug mode 7 years ago
client refactor: vue fixes + modal-upgrade-system.vue 7 years ago
npm chore: Updated package version 7 years ago
server fix: nav.root french translation 7 years ago
test refactor: moved server content to /server 7 years ago
.babelrc Base Project Files 8 years ago
.editorconfig User delete feature 8 years ago
.eslintignore Migrated to Fusebox 7 years ago
.eslintrc.json refactor: editor codeblock -> Vue component 7 years ago
.gitattributes Base Project Files 8 years ago
.gitignore refactor: lazy-load simplemde + minimal lodash 7 years ago
.pug-lintrc.json Fixed pug linting issues 8 years ago
.snyk fix: Updated dependencies + snyk 7 years ago
.travis.yml chore: Excluded docker branch from Travis build 7 years ago
CHANGELOG.md docs: Updated versions 7 years ago
Dockerfile Update Dockerfile 7 years ago
LICENSE Initial commit 8 years ago
README.md Update README.md 7 years ago
config.sample.yml chore: Removed empty localizations + updated dependencies 7 years ago
docker-compose.yml fix: Removed duplicate pkg + Dockerfile (alpha) 7 years ago
fuse.js refactor: editor codeblock -> Vue component 7 years ago
package.json chore: updated dependencies 7 years ago
tsconfig.json refactor: Upgrade to Fusebox 2.0 7 years ago
wiki.cmd npm install feature 8 years ago
wiki.js refactor: moved server content to /server 7 years ago
yarn.lock chore: updated dependencies 7 years ago

README.md

Wiki.js

Release License npm Downloads Chat on Gitter Twitter Follow
Build Status Codefresh Build Status Codacy Badge Dependency Status Known Vulnerabilities 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
  • History / Revert to previous version feature
  • Docker support + Auto compile/publish to Docker Hub
  • Optional Two-Steps Authentication (2FA)
  • Server-side TeX/MathML rendering
  • Render linebreaks by default (Github style)
  • 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.