/staticsite

Static site generator
  1. Python 80.4%
  2. HTML 15.7%
  3. CSS 3.8%
  4. Shell 0.1%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
debian Prepared new release Jul 24, 2018
doc Merge pull request #12 from DonKult/feature/configure-mdexts Jul 24, 2018
example Allow to specify multiple theme directories, using the first that is … Jul 24, 2018
staticsite Allow to specify multiple theme directories, using the first that is … Jul 24, 2018
tests Allow to specify multiple theme directories, using the first that is … Jul 24, 2018
.coveragerc Added script to run checks with code coverage Nov 6, 2016
.gitignore Added script to run checks with code coverage Nov 6, 2016
LICENSE Initial import as a fork from siterefactor Feb 28, 2016
MANIFEST.in Prepared new release Jul 24, 2018
NEWS.md Fixed markdown syntax for link targets Aug 20, 2016
README.md Added documentation for page series Feb 22, 2017
coverage.sh Added script to run checks with code coverage Nov 6, 2016
setup.py Updated the Debian packaging to make livereload a Recommends. Thanks @… Feb 21, 2017
ssite Fixed command line description Mar 4, 2016

README.md

staticsite

Static site generator.

Input:

  • a configuration file
  • markdown files
  • jinja2 templates
  • any other file that should be published as-is

Output:

  • a site with the same structure as the input

Dependencies

apt install python3-tz python3-unidecode python3-markdown python3-toml \
            python3-yaml python3-jinja2 python3-dateutil python3-livereload \
            python3-slugify

Quick start

Example steps to create a new post, seeing it in the live preview, and build the site ready to be published:

  1. Start a preview of the site: ssite serve example
  2. Open http://localhost:8000 in the browser.
  3. Create a new post: ssite new example
  4. Save the new post, it automatically appears in the home page in the browser.
  5. Finally, build the site: ssite build example
  6. The built site will be in example/web ready to be served by a web server.

Useful tips:

  • keep your browser open on ssite serve for an automatic live preview of everything you do
  • you can use python3 -m http.server 8000 --bind 127.0.0.1 to serve the result of ssite build and test your website before publishing
  • a quick rsync command for publishing the site: rsync -avz example/web/ server:/path/to/webspace

Index of the documentation

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author

Enrico Zini enrico@enricozini.org