Install

---

• From source

  MAC OS and (most) Linux users already have python installed.
  Windows users may prefer the binary version.
  For pyside installation, see there or there for windows users.

  Download pimouss sources, unzip and:

  • install

    (sudo) python setup.py install
    

  • Or just launch the main script

    python igloo.py
    

• Binaries

  Nothing to do: download binary for your platform, extract archive and launch it. No dependencies, can even run of a USB key.

Run

---

• Once installed simply type:

  igloo.py
  

This will try to launch he GUI. If not, you will fall back on command-line interface.
Warning: GUI currently use pyside (a Qt python binding). Install it before.

Graphical interface
See Screenshots tabs

Command line interface

usage: pimouss.py [-h] [-r] [-b BUILD_PATH] [-g GENERATE_PATH] input_path

pimouss v.0.1.0-beta: static website generator

positional arguments:
  input_path            input folder (content).

optional arguments:
  -h, --help                                      show this help message and exit
  -r, --recursive                                 recursively look for markdown file
  -b BUILD_PATH, --build_path BUILD_PATH          build path
  -g GENERATE_PATH, --generate_path GENERATE_PATH generate path

Usage

---

1. Write your markdown file (.md extension)
2. (optionnal) Write your template in a layout.tpl file. If none is provided, default one will be used.
3. (optionnal) Add a static folder with all your assets (img/css/js)
4. Launch pimouss and look your html output!

Then, modify your markdown and re-generate html pages.

Project structure

• Static folder and layout

   -[ static/js    
   -[ static/css     
   -[ static/img   
   - layout.tpl
  

• Content
  Your content in HTML/markdown (with *.md extension).

   - index.md                
   - index.tabname1.md   
   - index.tabname2.md   
   - pagename1.tabname3.md      
   - pagename1.tabname4.md
  

To know more about markdown syntax see this reference.

Notes/tips

• Tabs & filename
  The following filenames:

   - index.md
   - index.tabname1.md
   - index.tabname2.md
  

  Will become a single index.html page with 2 tabs : tabname1 & tabname2.

• Writing content

  • You can write html snippet in markdown file. In fact, that's the recommended way for heavy customisation.
  • Warning : Pimouss use python standard templating. So HTML inline javascript is not supported (due to $ character) neither in the layout, nor in the content. But you can easily write a proper javascript file, put it under static/js, and include it in your layout.

Trouble
Bugs submission is done via guithub bugtracker.

View Open Bug Submit a Bug