+ Contact
++
+ +{{ test_text }}
+``` + +You can declare the variables using YAML instead. Just surround the block with the `---` +and `...` [Document Separators](http://yaml.org/spec/1.1/#id857577). Then the objects +and arrays will be available inside the templates: + +``` +--- +header_text: Lorem Ipsum +custom_object: + name: Lorem + description: Ipsum +custom_array: + - + name: lorem + - + name: ipsum +... + +{% for item in custom_array %} +{{ header_text }}: {{ item.name }}
+{% endfor %} + +{{ custom_object.name }} | {{ custom_object.description }}
+``` + +The *PyYAML* library is used for this functionality. + +#### Asset pipeline + +Cactus comes with an asset pipeline for your static files. If you'd like to use it, make sure you use the {% static %} +template tag to link to your static assets: they might be renamed in the process. + + +##### Fingerprinting + +Modify `config.json`, and add the extensions you want to be fingerprinting: + + "fingerprint": [ + "js", + "css" + ], + +This lets you enable caching with long expiration dates. When a file changes, its name will reflect the change. Great for when you use a CDN. + + +##### Optimization + +Modify `config.json`, and add the extensions you want to be optimizing: + + "optimize": [ + "js", + "css" + ], + + +By default, Cactus will use: + + + YUI for CSS minification + + Closure compiler for JS minification (YUI is built-in too, so you can use it!) + +Check out `plugins/static_optimizes.py` in your project to understand how this works. It's very easy to add your own +optimizers! + + +#### Site URL + +If you would like for your sitemap to have absolute paths you need to +add a site-url key to your config.json + +You can enable this by adding modifying your configuration and adding: + + "site-url": "http://yoursite.com", + +Note that you need to do this if you want your sitemap to be valid for Google Webmaster Tools. + + +#### "Pretty" URLs + +If you would like to not have ".html" in your URLs, Cactus can rewrite those for you, and make "/my-page.html" look +appear as "/my-page/", by creating the "/my-page/index.html" file. + +You can enable this by adding modifying your configuration and adding: + + "prettify": true + +Note that if you're going to use this, you should definitely set your "Meta canonical" to the URL you're using so as +to not hurt your search rankings: + + + + +#### Nameserver configuration + +To set up a hosted zone and generate the correct nameserver records for your domain, make sure your bucket is a valid domain name, and run: + + cactus domain:setup + +Cactus will return with a set of nameservers that you can then enter with your registrar. To see the list again run: + + cactus domain:list + +If your domain is 'naked' (eg. without www), Cactus will add create an extra bucket that redirects the www variant of your domain to your naked domain (so www.lavacactus.com to cactus.com). All the above is Amazon only for now. + + +#### Extra files + +Cactus will auto generate a `robots.txt` and `sitemap.xml` file for you based on your pages. + +This will help bots to index your pages for Google and Bing for example. + + [cactus_github_page]: https://github.com/eudicots/Cactus + [django_templates]: http://docs.djangoproject.com/en/dev/topics/templates/ diff --git a/config.json b/config.json new file mode 100644 index 0000000..d40f98d --- /dev/null +++ b/config.json @@ -0,0 +1,3 @@ +{ + "prettify": true +} diff --git a/locale/README.md b/locale/README.md new file mode 100644 index 0000000..3332ba4 --- /dev/null +++ b/locale/README.md @@ -0,0 +1,15 @@ +# Internationalization + +## Using internationalization with LavaCactus + +To enable internationalization for your project: + + 1. Add a `use_translate` key to your configuration file + 2. Add `default_language` key to your configuration file with main language. For example `default_language="en"` + 3. Add `other_languages` key to your configuration file with the list of the other languages. + For example `other_languages=["ua", "ru"]` + 4. Mark strings for translation in your site (using `{% trans %}`) + 5. Put `{% load i18n %}` at the top of template with `trans` tags + 6. Run `cactus messages:make` + 7. Edit the .po file that was created with translations. + 8. Run `cactus build` to create multilanguage site structure diff --git a/pages/about.html b/pages/about.html new file mode 100644 index 0000000..92a00e7 --- /dev/null +++ b/pages/about.html @@ -0,0 +1,31 @@ +{% extends "base.html" %} +{% block title %} + About +{% endblock %} + +{% block body %} + ++ LavaCactus is a simple but powerful static website generator using + Python and the Django template system. LavaCactus also makes it easy to develop + locally. It works great for company, + portfolio, personal, support websites and blogs. +
++
+ ++ This is Open Source project with BSD-3-Clause license +
+The page could not be found on this server.
+
+ + Get started with this template based on Bootstrap 5. Go ahead, explore! +
+LavaCactus uses and extends Django's templating engine. If you've built sites using Django before, you'll feel right at home.
+LavaCactus can prettify URLs, so you can turn /about.html into a fancier /about/ or just use about.html.
For maximum performance, LavaCactus can minify and fingerprint your static assets. As for your pages, LavaCactus will automatically compress them.
+There's of course a lot more you can do with LavaCactus. Plus, LavaCactus's plugin framework lets you easily extend its functionality.
+