Springheel Documentation¶
Welcome to Springheel’s documentation!
Springheel is a static site generator for webcomics.
Whether it’s static site generators or Wordpress plugins, most existing software is geared towards blogs, not comics. Adapting them to work with comics is kludgey and fragile, and unnecessarily exposes you to security problems. But why force a square peg into a round hole when round pegs are easy enough to make? With that in mind I created Springheel. (The name comes from Spring-heel Jack, for the “English monster” naming scheme that many static generators keep to.)
Keep in mind that I’m self-taught (obligatory xkcd) and maybe don’t look too closely at the actual code, although it’s getting better.
Contents:
- springheel
- springheel package
- Submodules
- springheel.acopy module
- springheel.addimg module
- springheel.classes module
- springheel.command_line module
- springheel.copystuff module
- springheel.genabout module
- springheel.genchars module
- springheel.genchbook module
- springheel.generatearchive module
- springheel.generatenav module
- springheel.genextra module
- springheel.genjsonfeed module
- springheel.genmultilang module
- springheel.genmultipleindex module
- springheel.genrss module
- springheel.genstatline module
- springheel.gentopnav module
- springheel.gentrans module
- springheel.gettemplatenames module
- springheel.metatag module
- springheel.parseconf module
- springheel.parsemeta module
- springheel.parsetranscript module
- springheel.renameimgs module
- springheel.slugurl module
- springheel.socialbuttons module
- springheel.splitseps module
- springheel.springheelinit module
- springheel.tl module
- springheel.webtoon module
- springheel.wraptag module
- Module contents
- Submodules
- springheel package
- Themes
- Translation API
- How to use Springheel
- Extending Springheel Sites
- Frequently Asked Questions
- Q. Must I include a transcript for every strip?
- Q. I’m on a Mac and…
- Q. How do I fix the encoding errors when I run Springheel through the Windows command line?
- Q. The date format you use is weird!
- Q. Why is the text so big?
- Q. Why doesn’t Springheel keep track of the time a comic was published, instead of just the date?
- Q. Can you recommend a good web host?
- Q. Why don’t the navigation arrows come with hovered versions?
- Q. Why doesn’t Springheel use JavaScript? If you used JS you could do <blah blah>…
- Q. Does the “note” theme follow Material Design guidelines?
- Q. Filenames aren’t slugified correctly, or I get slugify-related build errors.
- Springheel Changelog
- Version 7.0.0 “Chilchuck”
- Version 6.0.3
- Version 6.0.2
- Version 6.0.1
- Version 6.0.0 “Ukyou”
- Version 5.2.4
- Version 5.2.3
- Version 5.2.2
- Version 5.2.1
- Version 5.2.0 “Bossun”
- Version 5.1.0 “Senku”
- Version 5.0.3
- Version 5.0.2
- Version 5.0.1
- Version 5.0.0 “Azumane”
- Version 4.1.0
- Version 4.0.0
- Version 3.0.3
- Version 3.0.2
- Version 3.0.1
- Version 3.0.0
- Version 2.0.0
- Version 1.0.2
- Version 1.0.1
- Version 1.0.0