Template engine for static sites and sane people
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
AutoSite
LICENSE
README.md
requirements.txt
setup.py

README.md

AutoSite

AutoSite helps you keep all of your website's pages in the same basic template. Managing a navigation bar, a footer, and even meta/OpenGraph tags across several pages is simple.

Try it online on repl.it

PyPI

Github

Unofficial guide

Installation

As a package

You can install AutoSite as a package. You can cd to the directory where you're building your site and build with the autosite command. It can be installed with the command pip install autosite or pip3 install autosite depending on your configuration.

Embedded

__init__.py can also be run directly like the pre-PyPI AutoSite script. Just paste it into wherever you're working and you can run it from there. You'll need to install the requirements manually, which are in the requirements.txt file with the pip install -r requirements.txt or pip3 install -r requirements.txt commands (provided that you downloaded or wrote that file to the same directory).

Usage

  1. Run autosite. It will create a basic default.html template and the in and includes folders.

  2. Edit templates/default.html, filling in with these tags:

        [#content#] - The page's content.
        [#path#] - The relative file path from root.
        [#root#] - Use this to point to the site's root folder.
    

    You can also use any other attributes, like [#title#] or [#description#], provided that you define them in each page as below.

  3. Add your pages to the "in" folder. You can define a title and description, or any other attributes you wish, and tell AutoSite which template to use for the page at the top of the file like so:

        <!-- attrib title: Your title -->
        <!-- attrib description: Your description -->
        <!-- attrib template: default -->
        <p>Everything under the above lines will replace [#content#] in template.html.</p>
    

    Put other site files in the "includes" folder. Input pages can be HTML or Markdown files, and use the same attribute syntax.

  4. Run the script. How long it takes depends on how large your site is. Your pages will be in the "out" folder.

Conditional text

Many sites have a navigation where if you're on a page, that page's name in the navigation is not a link. AutoSite has a feature that lets you replicate this. Consider the following example:

  [path!=index.html]<a href="[#root#]index.html">[/path!=]
      Home
  [path!=index.html]</a>[/path!=]

You can also omit the ! symbol and it will only show if it is that page, like this:

  [path=index.html]<p>[/path=]
      This is the index page.
  [path=index.html]<p>[/path=]

Conditional text is not limited to just file paths! Nearly any attribute can be used with conditional text.

However, conditional text still has some issues. You can only have one instance of conditional text per line, it is not nestable, and not multiline either.