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.
445 Commits
3 Branches
120 Tags
87 MiB
 
 
 
 
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '247d598edb'
${ noResults }
Go to file
NGPixel 247d598edb
feat: Color Themes - Header + Sidebar + Footer support 		8 years ago
.build refactor: Pre-render TeX + MathML server-side to SVG 8 years ago
.github docs: Updated issue template 8 years ago
.vscode fix: Incorrect indentation (eslint) 8 years ago
assets feat: updated icons to Nucleo 8 years ago
client feat: Color Themes - Header + Sidebar + Footer support 8 years ago
npm fix: Docker fixes 8 years ago
server feat: Color Themes - Header + Sidebar + Footer support 8 years ago
test refactor: moved server content to /server 8 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
.pug-lintrc.json Fixed pug linting issues 8 years ago
.snyk fix: Updated dependencies + snyk 8 years ago
.travis.yml chore: Excluded docker branch from Travis build 8 years ago
CHANGELOG.md feat: Color Theme page UI + color picker + toggle 8 years ago
Dockerfile fix: Docker fixes 8 years ago
LICENSE Initial commit 8 years ago
README.md docs: updated milestones 8 years ago
config.sample.yml feat: Optional linebreaks + mathjax processing 8 years ago
docker-compose.yml fix: Docker fixes 8 years ago
fuse.js refactor: Pre-render TeX + MathML server-side to SVG 8 years ago
package.json refactor: Pre-render TeX + MathML server-side to SVG 8 years ago
tsconfig.json refactor: Upgrade to Fusebox 2.0 8 years ago
wiki.cmd npm install feature 8 years ago
wiki.js refactor: moved server content to /server 8 years ago
yarn.lock refactor: Pre-render TeX + MathML server-side to SVG 8 years ago

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.