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.
494 Commits
3 Branches
120 Tags
86 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '78c875503c'
${ noResults }
Go to file
Nicolas Giard 78c875503c
docs: updated milestones 		7 years ago
.build refactor: Pre-render TeX + MathML server-side to SVG 7 years ago
.github docs: Updated issue template 8 years ago
.vscode fix: Incorrect indentation (eslint) 7 years ago
assets feat: updated icons to Nucleo 7 years ago
client fix: search results href siteRoot undefined 7 years ago
npm fix: Safari/iOS const redefinition 7 years ago
server fix: infinite loop on termination signal 7 years ago
test chore: remove snyk 7 years ago
.babelrc Base Project Files 8 years ago
.editorconfig User delete feature 8 years ago
.eslintignore Migrated to Fusebox 8 years ago
.eslintrc.json refactor: editor codeblock -> Vue component 8 years ago
.gitattributes Base Project Files 8 years ago
.gitignore refactor: lazy-load simplemde + minimal lodash 8 years ago
.npmrc fix: lock dependencies 7 years ago
.pug-lintrc.json Fixed pug linting issues 8 years ago
.travis.yml fix: missing icons + updated versions 7 years ago
.yarnrc fix: lock dependencies 7 years ago
CHANGELOG.md docs: updated changelog 7 years ago
Dockerfile fix: Docker fixes 7 years ago
LICENSE Initial commit 8 years ago
README.md docs: updated milestones 7 years ago
config.sample.yml fix: Safari + iOS load bug 7 years ago
docker-compose.yml fix: Docker fixes 7 years ago
fuse.js fix: Safari/iOS const redefinition 7 years ago
package.json fix: Safari/iOS const redefinition 7 years ago
tsconfig.json fix: Safari/iOS const redefinition 7 years ago
wiki.cmd npm install feature 8 years ago
wiki.js refactor: moved server content to /server 8 years ago
yarn.lock fix: Safari/iOS const redefinition 7 years ago

README.md

Wiki.js

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

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.11.1 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):

1.0.0 - Beta 13

Progress

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

1.0.1 - Stable

Progress

  • Bug fixes release

2.0.0 - Dev

Progress

Breaking Changes: MongoDB is being phased out in favor of PostgreSQL + Redis. An upgrade tool will be provided to migrate existing data to the new system.

  • Migrate to PostgreSQL + Redis datastore
  • History / Revert to previous version
  • Optional Two-Steps Authentication (2FA)
  • Docker support + Auto compile/publish to Docker Hub
  • Support sub-directory installations (e.g. example.com/wiki)
  • Persist system settings to database instead of file-based

Future

  • User Groups + Better permissions management
  • 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.