What is amWiki used for?

amWiki is a lightweight Markdown wiki system that generates a static site from .md files, with no database or server-side code required. It is a good fit for team knowledge bases on static hosting, API documentation sites and personal wikis.

Is amWiki open source?

Yes. amWiki is open source under the MIT licence. Its source code is on GitHub at TevinLi/amWiki and is written mainly in JavaScript.

Yes. amWiki is open source, so the software itself is free to use.

Can I self-host amWiki?

Yes. amWiki can be self-hosted on your own server or infrastructure; there is no official hosted version.

What is amWiki an alternative to?

amWiki is an open-source alternative to GitBook and Confluence. Other open-source alternatives to GitBook include Wiki.js, Raneto and MrDoc.

Is amWiki actively maintained?

The most recent commit to amWiki was on 11 January 2021, and the latest release is v1.2.1, published on 7 August 2017. The project has 983 stars on GitHub.

amWiki: open-source alternative to GitBook, Confluence

About amWiki

amWiki is a lightweight, front-end wiki system written in JavaScript for personal and team documentation. You write pages in Markdown, keep them as local .md files and publish the result as a static site, so no database or server-side development is needed. Its documentation is written mainly in Chinese.

It can create a new wiki with one action, update the navigation tree automatically, handle nested directories and paste screenshots directly into a page as local PNG files. Pages adapt to different screen sizes, search runs entirely in the browser with scored results, and API documentation can be parsed to produce simple Ajax tests.

Editing happens through either the Atom editor plugin or an npm command-line module, and the two share the same wikis. Neither is needed to view the result because the output is plain static HTML that any web host can serve. amWiki is released under the MIT license.

Key features

Markdown pages stored as local files
No database or server code required
Automatic navigation tree updates
Multi-level directories
Paste screenshots straight into pages
Client-side search with ranked results
API docs with simple Ajax testing

Good fit for

→Team knowledge bases on static hosting
→API documentation sites
→Personal wikis

Built with: JavaScript
Tags: wiki; markdown; documentation; static-site; atom; nodejs; api-docs; knowledge-base

amWiki: questions and answers

What is amWiki used for?: amWiki is a lightweight Markdown wiki system that generates a static site from .md files, with no database or server-side code required. It is a good fit for team knowledge bases on static hosting, API documentation sites and personal wikis.
Is amWiki open source?: Yes. amWiki is open source under the MIT licence. Its source code is on GitHub at TevinLi/amWiki and is written mainly in JavaScript.
Is amWiki free?: Yes. amWiki is open source, so the software itself is free to use.
Can I self-host amWiki?: Yes. amWiki can be self-hosted on your own server or infrastructure; there is no official hosted version.
What is amWiki an alternative to?: amWiki is an open-source alternative to GitBook and Confluence. Other open-source alternatives to GitBook include Wiki.js, Raneto and MrDoc.
Is amWiki actively maintained?: The most recent commit to amWiki was on 11 January 2021, and the latest release is v1.2.1, published on 7 August 2017. The project has 983 stars on GitHub.