mpm + documentation   33

mdBook is a utility to create modern online books from Markdown files.
12 weeks ago by mpm
A Hugo theme for creating great technical documentation sites
12 weeks ago by mpm
Project documentation with Markdown.
12 weeks ago by mpm
The multi-repository documentation site generator for tech writers who love writing in AsciiDoc.
january 2019 by mpm
Provide a way for researchers and engineers to quickly generate ASCII RFC-like header diagrams for their own custom protocols.
diagram  protocol  documentation 
november 2018 by mpm
The C4 model for software architecture
The C4 model was created as a way to help software development teams describe and communicate software architecture, both during up-front design sessions and when retrospectively documenting an existing codebase. It's a way to create maps of your code, at various levels of detail, in the same way you would use something like Google Maps to zoom in and out of an area you are interested in.
architecture  documentation 
august 2018 by mpm draws network diagrams dynamically from a text file describing the placement, layout and icons. Given a yaml file describing the hierarchy of the network and it's connections, a resulting diagram will be created
documentation  diagram 
march 2018 by mpm
Convert your ascii diagram scribbles into happy little SVG
documentation  diagram 
february 2018 by mpm
Pandoc Lua Filters
Starting with pandoc 2.0, we have made it possible to write filters in lua without any external dependencies at all. A lua interpreter and a lua library for creating pandoc filters is built into the pandoc executable.
pandoc  documentation 
december 2017 by mpm
Doxyrest is a compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen, feeds those to the Lua-based string template engine and produces reStructuredText suitable for being passed further on to the Python documentation generator Sphinx.
april 2017 by mpm
Documentation at scale: The principles
Documentation is a read-once affair. It's only read by newbies who don't have sufficient knowledge to improve it. Senior people, who can, at least in theory, fix it, never use it. So, here's a list of principles that could alleviate the problem
july 2016 by mpm
Pandoc filters are pipes that read a JSON serialization of the Pandoc AST from stdin, transform it in some way, and write it to stdout
pandoc  python  uml  documentation 
april 2016 by mpm
Simple markup to produce academic publications using Pandoc
documentation  pandoc 
march 2016 by mpm
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation
december 2015 by mpm
Madoko is a fast markdown processor for writing professional articles, books, manuals, webpages and presentations, with a focus on simplicity and plain text readability
latex  documentation 
september 2015 by mpm
Plain Text, Papers, Pandoc
first I will say a little bit about the general problem, and then I will tell you something specific: how to take the draft of a scholarly paper, typically including bibliographical references, figures, and the results of some data analysis, and turn it into nice-looking PDF and HTML output. The hopefully redeeming thing about this discussion is that it will help you use the various resources I make available for doing this. If you want to copy what I do, you should be able to
latex  pandoc  documentation 
september 2015 by mpm
Some elementary (xe)tex templates and css files for Pandoc, for use with latex-custom-kjh
documentation  latex 
september 2015 by mpm
C++11 port of docopt
documentation  c++ 
june 2015 by mpm
mdocml = mandoc
mandoc is a suite of tools compiling mdoc, the roff macro language of choice for BSD manual pages, and man, the predominant historical language for UNIX manuals. It is small, ISO C, ISC-licensed, and quite fast. The main component of the toolset is the mandoc utility program, based on the libmandoc validating compiler, to format output for UNIX terminals (with support for wide-character locales), XHTML, HTML, PostScript, and PDF.
december 2014 by mpm
How I stopped worrying and started using Markdown like TeX
For most of the last decade, I have almost exclusively used LaTeX/ConTeXt for writing all my documents. After moving to Markdown, I miss three features of TeX: separation of content and presentation; conditional inclusion of content; and including external documents. In this post, I’ll explain how to get these with Markdown.
latex  documentation 
april 2014 by mpm
Generic Preprocessor
GPP is a general-purpose preprocessor with customizable syntax, suitable for a wide range of preprocessing tasks. Its independence from any programming language makes it much more versatile than cpp, while its syntax is lighter and more flexible than that of m4.

GPP is targeted at all common preprocessing tasks where cpp is not suitable and where no very sophisticated features are needed. In order to be able to process equally efficiently text files or source code in a variety of languages, the syntax used by GPP is fully customizable. The handling of comments and strings is especially advanced.
april 2014 by mpm
everything I know about git
This repo contains all my notes about git. I started writing them for my own understanding, almost like cheat sheets, but they may be useful for others also
documentation  git 
november 2013 by mpm is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
july 2013 by mpm
Pretty RFC
RFCs are documents produced by The Internet Engineering Task Force,and many are official standards for various Internet protocols. This site indexes and formats these documents for easier finding & viewing.
march 2013 by mpm
mdoc is a guide for composing well-formed and maintainable UNIX manuals ("manpages") in the mdoc language.
unix  linux  documentation 
august 2011 by mpm
ASCII Flow Diagram Tool
diagram  documentation 
june 2011 by mpm
ronn(7) -- the opposite of roff
Ronn is a humane text format and toolchain for creating UNIX man pages, and things that appear as man pages from a distance
march 2010 by mpm
AsciiDoc is a text document format for writing short documents, articles, books and UNIX man pages
march 2010 by mpm
Docco is a quick-and-dirty, hundred-line-long, literate-programming-style documentation generator
march 2010 by mpm
If you need to convert files from one markup format into another, pandoc is your swiss-army knife
latex  haskell  pdf  xml  documentation 
august 2009 by mpm
Sphinx Documentation
Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects
python  documentation 
march 2008 by mpm

Copy this bookmark: