Markdoc is a lightweight Markdown-based wiki system. It’s been designed to allow
you to create and manage wikis as quickly and easily as possible.
What is it good for?
Potential use cases for Markdoc include, but aren’t limited to:
Technical Documentation/Manuals
Markdoc can be used to write and render hand-written guides and manuals for
software. Such documentation will normally be separate from
automatically-generated API documentation, and might give a higher-level
view than API docs alone. It might be used for client documentation for
web/desktop applications, or even developer documentation for frameworks.
Internal Project Wikis
Markdoc wikis consist of a single plain-text file per page. By combining a
wiki with a DVCS (such as Mercurial or Git), you can collaborate
with several other people. Use the DVCS to track, share and merge changes
with one another, and view the wiki’s history.
Static Site Generation
Markdoc converts wikis into raw HTML files and media. This allows you to
manage a blog, personal website or a collection of pages in a Markdoc wiki,
perhaps with custom CSS styles, and publish the rendered HTML to a website.
Markdoc need not be installed on the hosting site, since the resultant HTML
is completely independent.
Markdoc is public domain software. It will always be completely
free to use, and you can redistribute it (in part or in whole) under any
circumstances (open-source, proprietary or otherwise) with no attribution or
encumberances.
Quickstart
Requirements
The minimum requirements to run the Markdoc utility are:
Python 2.4 or later (2.5+ highly recommended)
A UNIX (or at least POSIX-compliant) operating system
rsync -- installed out of the box with most
modern OSes, including Mac OS X and Ubuntu. In the future Markdoc may
include a pure-Python implementation.
Installation
$ easy_install Markdoc # OR
$ pip install Markdoc
Making a Wiki
markdoc init my-wiki
cd my-wiki/
vim wiki/somefile.md
# ... write some documentation ...
markdoc build
markdoc serve
# .. open http://localhost:8008/ in a browser ...
(Un)license
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.
In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
请发表评论