Markdoc

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.

Cool Features

Set up Google Analytics tracking in one line of configuration.
Barebones wikis that just look like directories with Markdown-formatted text files in them.
A built-in HTTP server and WSGI application to serve up a compiled wiki with a single command.
Continuous builds (via rsync) mean the server can keep running whilst Markdoc re-compiles the wiki. Just refresh your browser to see the changes.
Add Pygments-powered syntax highlighting to your Markdoc wiki with a single configuration parameter.
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.

Where do I start?

The quickstart document has all the information you need to put together a simple Markdoc wiki. The authoring guide provides a quick introduction to writing Markdoc pages themselves, especially with regards to linking between pages.

Reference

See the configuration reference for in-depth knowledge on writing your markdoc.yaml file. The layout reference describes the basic filesystem layout for a Markdoc wiki, and the tips directory contains several handy recipes.

The Markdoc project’s goals and history are described in the about page. If you’d like to know more about how Markdoc works at a deeper level, take a look at the internals directory. Developers interested in hacking the utility will likely want the development page.

To see the complete list of pages in this wiki, you can browse the directory listing.

以上...

码不停提马上无虫 ;-)

|_|0|_|
|_|_|0|
|0|0|0|

加入珠海GDG

注册 G+
关注 GDG Zhuhai
成为 GDG Zhuha开发者

通过珠海GDG 可以:

    第一时间获知谷歌最新的技术,
    可以学到如何去谷歌平台上赚钱的思路和方法,
    可以认识很多有可能将来一起走上自己创业道路的人,
    可以学会把你的创新带向国际市场,
    参加那里的活动有经常和国际上的开发者们进行交流的机会...

PS:

若无意外,题图都是从原文提取或是通过 Google 图片搜索出来的, 版权属左, 不负责任 ;-)

PPS:

珠海GDG wechat/Blog 都是欢迎投稿的,只要追认内容吻合以下条件:

0. 有趣 ~ 至少是自个儿有兴趣的领域吧...
1. 有料 ~ 至少有点儿原创的东西吧..
2. 有种 ~ 至少不能是成功学吧!

有好物的,及时向大妈们吼: [email protected]

微信栏目

当前应该是:

    G术图书 (gb:推荐好书,书无中外)
    D码点评 (dd:麻辣评点,善意满盈)
    G说公论 (gt:时评杂文,新旧不拘)
    珠的自白(dm:大妈自述,每周一篇)
    海选文章(hd:得要相信,大妈法眼)

总之! 珠海的组委大妈们,决定开始坚持发文,方方面面细细同大家分享/交流

总之! 请大家告诉大家, 珠海生活中的技术社区 已经认真回归微信,都来订阅吧!

订阅方法

搜索微信号 GDG-ZhuHai
或查找公众号: GDG珠海
或扫描:

GDG珠海社区资源:

邮件列表: [email protected] (可发空邮件到 [email protected] 即完成订阅)
微博: @GDG珠海
微信: GDG珠海
G+ 主页: GDG ZhuHai
G+ 社群: ZhuHai GDG

Author:

/mail / gittip / github