easy file-based static website builder
Just write content files, mixing HTML and markdown syntax
static/img/ /css/ /js/ layout.tpl index.md index.tab1.md index.tab2.md about.md about.author.md about.contact.md
static/img/ /css/ /js/ index.html about.html
Download pimouss sources, unzip and:
(sudo) python setup.py install
Or just launch the main script
Nothing to do: download binary for your platform, extract archive and launch it. No dependencies, can even run of a USB key.
Once installed simply type:
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.
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
layout.tplfile. If none is provided, default one will be used.
Then, modify your markdown and re-generate html pages.
Static folder and layout
-[ static/js -[ static/css -[ static/img - layout.tpl
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.
Tabs & filename
The following filenames:
- index.md - index.tabname1.md - index.tabname2.md
Will become a single
index.html page with 2 tabs :
Bugs submission is done via guithub bugtracker.
Copyright (C) 2013 Sebastien Stang
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
I develop this software on my spare time. I also provide some services/support around this software. Feel free to contact me for more information.
If you liked it, you can contribute in various ways:
[user] financial contribution:
Or simply by promoting this software around you!