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
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 Outline, Wiki.js and Raneto.
- 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 984 stars on GitHub, with 1 added in the last 30 days.
Open-source alternatives to amWiki
See all
Outline
Docs & Wikis
The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature p
OSSvs Confluence★ 41k
Wiki.js
Docs & Wikis
Wiki.js | Next Generation Open Source Wiki
AGPL-3.0vs Confluence★ 29k
Raneto
Docs & Wikis
Markdown powered Knowledgebase Wiki for Node.js
MITvs GitBook★ 2.9k
MrDoc
Docs & Wikis
mrdoc,online document system developed based on python. It is suitable for individuals and
GPL-3.0vs Confluence★ 3.2k
BookStack
Docs & Wikis
bookstack - A platform to create documentation/wiki content built with PHP & Laravel
MITvs Confluence★ 19k
MediaWiki
Docs & Wikis
🌻 The collaborative editing software that runs Wikipedia. Mirror from https://gerrit.wiki
OSSvs Confluence★ 5.2k
SaaS alternatives to amWiki
See all
GitBook
Docs & Wikis
GitBook is a documentation and knowledge platform that keeps product docs accurate for people and AI, with docs-as-code support and an MCP server.
SaaS
Confluence
Docs & Wikis
Confluence is Atlassian's team workspace for writing, organizing and sharing documentation and knowledge, with AI help for drafting, summarizing and finding answers.
SaaS
Document360
Docs & Wikis
Knowledge base software for product documentation and self-service
SaaS
Slite
Docs & Wikis
Team knowledge base with docs, channels and AI-assisted search
SaaS
Docsie
Docs & Wikis
Knowledge portal and documentation hub with versioning and translations
SaaS
Guru
Docs & Wikis
Company wiki that surfaces verified answers inside chat and the browser
SaaS