An open source static site generator with an emphasis on code readability, written in Python! Easily turn markdown and html pages into a cohesive website with consistent theming.
- Install python 3 if it's not already on your computer
- Download the latest sidewinder release and extract the zip file
- Navigate to your extracted sidewinder folder
- (Optional, Linux-only) If you'd like to have a desktop entry for sidewinder
you can run from your app launcher directly:
- Copy the
Sidewinder.desktopfile to$HOME/.local/share/applications/ - Edit that copy such that
Pathkey equals the full path to this folder - Copy the sidewinder png icon to
$HOME/.icons/(make the folder if you need to) - Log out and log back in, or run
update-desktop-databasein a terminal
- Copy the
- Place markup files (either markdown or html) in the content folder.
- (Optional) Edit the file named
template.htmlto taste (keeping the{{ Title }}and{{ Content }}strings intact) - Run sidewinder:
- Windows: Double click
sidewinder.bat - MacOS: Double click
sidewinder.command - Linux: Right click
sidewinder.shand select the optionRun as program
- Windows: Double click
- Sidewinder will then create a new folder called
publicand compile your site there
To view the site locally, open the public folder, open a terminal or cmd.exe
window there, and run the following (cross-platform):
python -m http.server 8080While this runs in the terminal window, your site will be visible
here (or just enter localhost:8080 into your
browser window)
All static assets (CSS styling, images, icons, other media) will be copied from
the static folder into the root of public (keep that in mind for any local
hrefs or CSS url(...) directives).