davidfmiller / man

:blue_book: JS & CSS for software documentation

Home Page:http://davidfmiller.github.io/man/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

man

… is a lightweight CSS (& JS) library to make simple, attractive documentation for software projects. Focus is placed on simplicity & clarity with a nod to the monospaced world that software developers employ.

View the docs.

Building

sudo gem install compass
sudo npm i -g grunt
npm i
grunt compass
npx webpack

man.iatemplate

… is a preview template for iA Writer:

  • copy the bundle to ~/Library/Containers/pro.writer.mac/Data/Library/Application Support/iA Writer/Templates/
  • restart the app, and select man from the status/toolbar at the bottom of the preview pane

todos

  • line height of multi-line code blocks w/o JS
  • form elements in dark mode

About

:blue_book: JS & CSS for software documentation

http://davidfmiller.github.io/man/

License:ISC License


Languages

Language:JavaScript 53.6%Language:SCSS 44.5%Language:HTML 1.8%Language:CSS 0.0%