Pamflet – publishing application for short texts

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.

Features include:

  • 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.

Return to Scala Static Site Generators Home Page


Popular series
Linux for StartersNew to Linux? Read our Linux for Starters series. We start right at the basics and teach you everything you need to know to get started with Linux.
Free and Open Source SoftwareThe largest compilation of the best free and open source software in the universe. Each article is supplied with a legendary ratings chart helping you make informed decisions.
Linux ReviewsHundreds of in-depth reviews offering our unbiased and expert opinion on software. We offer helpful and impartial information.
Alternatives to GoogleAlternatives to Google's Products and Services examines your options to migrate from the Google ecosystem with open source Linux alternatives.
MicrosoftAlternatives to Microsoft's Products and Services recommends open source Linux software.
AdobeAlternatives to Adobe Cloud looks at free and open source alternatives to products available from Adobe Cloud's subscription service.
AppleAlternatives to Apple recommends free and open source alternatives to Apple's proprietary world.
CorelAlternatives to Corel surveys alternatives to Corel's range of graphics processing products and other software applications.
DockerGetting Started with Docker helps you master Docker, a set of platform as a service products that delivers software in packages called containers.
Linux System ToolsEssential Linux system tools focuses on small, indispensable utilities, useful for system administrators as well as regular users.
Linux ProductivityLinux utilities to maximise your productivity. Small, indispensable tools, useful for anyone running a Linux machine.
Home Computer EmulatorsHome computers became commonplace in the 1980s. Emulate home computers including the Commodore 64, Amiga, Atari ST, ZX81, Amstrad CPC, and ZX Spectrum.
Now and ThenNow and Then examines how promising open source software fared over the years. It can be a bumpy ride.
Linux at HomeLinux at Home looks at a range of home activities where Linux can play its part, making the most of our time at home, keeping active and engaged.
Linux CandyLinux Candy reveals the lighter side of Linux. Have some fun and escape from the daily drudgery.
Best Free Android AppsBest Free Android Apps. We showcase free Android apps that are definitely worth downloading. There's a strict eligibility criteria for inclusion in this series.
Programming BooksThese best free books accelerate your learning of every programming language. Learn a new language today!
Programming TutorialsThese free tutorials offer the perfect tonic to our free programming books series.
Stars and StripesStars and Stripes is an occasional series looking at the impact of Linux in the USA.
Share this article