Pamflet is a publishing application for short texts, particularly user documentation of open-source software. Pamflet generates a linked sets of pages called “pamflets”. Although hierarchical organization of pages is supported, the primary means of navigation is linear and authors are encouraged to write pamflets that progress logically when read front to back.
Pamflet reads source files from the source directory and produces finished web files at the destination. Sources with a markdown or md extension correspond to one html output file.
The table of contents appears at the bottom of every page. The first page of a pamflet should be brief so that the generated contents listing will appear above the fold. Think of it as a title page, with a few sentences of description.
It is designed to be easy to write and read on any platform.
Pamflet is free and open source software.
Key Features
- Preview mode allows you to check the layout and text rendering as much as you like while editing project documentation.
- Uses HTML ordered lists for Contents.
- Supports arbitrarily many nested sections, defined by directories beneath the primary source directory. These directories participate in the same name-based ordering as their adjacent markdown sources.
- Source code highlighting – hooks into the prettify.js source code highlighter.
- Custom stylesheets – all files in the source directory with the extension css will be packaged with the pamflet. These will be loaded after all other stylesheets.
- Supports template properties through StringTemplate.
- Special properties – checks for a special, optional property that links to a project’s GitHub repository, etc.
- Special template properties that enable globalization.
- Ships with three color schemes: github, monokai, and redmond.
- HTML5 cache manifest is generated for all pamflets.
Website: www.foundweekends.org/pamflet
Support: GitHub Code Repository
Developer: Kenji Yoshida
License: GNU Lesser General Public License v3.0
Pamflet is written in Scala. Learn Scala with our recommended free books and free tutorials.
Related Software
| Scala Static Site Generators | |
|---|---|
| Scalate | Template engine - HAML, Mustache and JSP, Erb and Velocity style syntaxes |
| Paradox | Markdown documentation tool for software projects |
| Pamflet | Publishing application for short texts |
| Hepek | Collection of useful projects for typesafe HTML construction |
| s2gen | Uses Freemarker as a template engine |
| Ornate | Tool for building multi-page HTML sites from Markdown sources |
Read our verdict in the software roundup.
 Explore our comprehensive directory of recommended free and open source software. Our carefully curated collection spans every major software category.This directory is part of our ongoing series of informative articles for Linux enthusiasts. It features hundreds of detailed reviews, along with open source alternatives to proprietary solutions from major corporations such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. You’ll also find interesting projects to try, hardware coverage, free programming books and tutorials, and much more. Discovered a useful open source Linux program that we haven’t covered yet? Let us know by completing this form. |