Skip to content

Commit

Permalink
release 0.2
Browse files Browse the repository at this point in the history
+ minor documentation update.
  • Loading branch information
hlef committed Jul 7, 2019
1 parent 04e1cab commit f7bbdfc
Show file tree
Hide file tree
Showing 6 changed files with 17 additions and 27 deletions.
34 changes: 13 additions & 21 deletions docs/basics-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Juliet website sources are organized as following:
├── assets
│   └── ...
├── config.yml
├── .addons
│   └── ...
├── pages
│   └── ...
├── posts
Expand All @@ -20,8 +18,7 @@ Juliet website sources are organized as following:

`juliet init` can initialize this file structure for you in the current directory.

By default juliet install a very rough theme skeleton to `themes/`. It works, but
it is probably not what you will want to use for your blog.
The default theme is [gram](https://github.com/hlef/juliet-gram-theme).

We recommend you to either pick and install one of our recommended themes (see
`docs/recommended-themes.md`), or be creative and design your own one! You will
Expand All @@ -39,7 +36,7 @@ any Juliet config file:
baseurl: ""

# the directory in themes/ that contain your theme
theme: sample
theme: sample_theme

The set of required entries in the configuration file may vary depending on your
theme. You can usually find more informations about it in your theme directory,
Expand Down Expand Up @@ -69,25 +66,25 @@ Apart from these, the set of required entries in post headers varies depending
on your theme. You can find more informations about it in your theme directory,
under `themes/your_theme/README`.

Please, note that even if it is empty, the header has to be present. Otherwise,
Juliet might get upset!
Please, note that even if it is empty, the header has to be present.

#### Creating a fresh article file

Because creating a fresh article structure each and every time you write a new
article is repetitive and annoying, Juliet >= 0.2 adds support for the
`juliet new` feature which takes care of it for you (pro tip: you can get
more information about this feature via `juliet new --help`!).
`juliet new` feature which takes care of it for you.

Pro tip: you can get more information about this feature via `juliet new --help`.

### :bookmark: Preprocessor tags
#### Pygments syntax highlighting

Juliet provides native integration of [Pygments](http://pygments.org/) syntax
highlighting.

To highlight code using Pygments, you'll simply need to embrace your code with
Jinja-like `{% highlight LANG %}` and `{% endhighlight %}` tags (replace *LANG*
by a lexer name).
To highlight code using Pygments, simply embrace your code with Jinja-like `{%
highlight LANG %}` and `{% endhighlight %}` tags (replace *LANG* by a lexer
name).

For example, highlighting a shell script works as following:

Expand Down Expand Up @@ -124,8 +121,6 @@ Juliet themes are organized as following:
├── data
│   ├── css
│   │   └── ...
│   ├── fonts
│   │   └── ...
│   └── js
│   └── ...
├── includes
Expand Down Expand Up @@ -160,10 +155,10 @@ You can also specify the source directory via `--build-src`.
### :file_folder: Installed structure

.
├── page1
├── page2
├── page1.html
├── page2.html
├── ...
├── static1.html
├── index.html
├── static2.html
├── ...
├── assets
Expand All @@ -186,7 +181,4 @@ root of the build area, and posts under `posts/`.
Also, unless `permalink` is defined the name under which pages/posts will be
installed is defined by the file naming variable. By default the file naming
variable is defined as the "title" entry, but this can be changed by defining
the `file_naming_variable` field in your `config.yml`.

If the file naming variable is not present, the source file name will be used
(but this is something you should rather consider avoiding).
the `file_naming_variable` field in `config.yml`.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/recommended-themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## [gram](https://github.com/hlef/juliet-gram-theme)
* :link: `https://github.com/hlef/juliet-gram-theme`
* Description: A lightweight theme for Juliet
* Description: Content-focused Juliet theme.
2 changes: 0 additions & 2 deletions docs/themes-howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,3 @@ This directory is perfect to include your site-wide ressources, like:
* fonts
* javascript files
* favicons

so one and so forth.
4 changes: 2 additions & 2 deletions juliet.1
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.TH JULIET "1" "Oct 2018" "juliet 0.2-alpha2" "User Commands"
.TH JULIET "1" "Jul 2019" "juliet 0.2" "User Commands"
.SH NAME
juliet \- The lightweight static website generator
.SH DESCRIPTION
Expand Down Expand Up @@ -30,4 +30,4 @@ show this help message and exit. When called with positional arguments, it provi
\fB\-\-version\fR, \fB\-v\fR
show program's version number and exit
.SH COPYRIGHT
This manual page is Copyright © 2018 Hugo Lefeuvre <hle@owl.eu.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation.
This manual page is Copyright © 2019 Hugo Lefeuvre <hle@owl.eu.com>. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 3 or any later version published by the Free Software Foundation.
2 changes: 1 addition & 1 deletion juliet/version.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = '0.2-alpha2'
__version__ = '0.2'
__author__ = 'Hugo Lefeuvre'
__author_email__ = 'hle@owl.eu.com'
__license__ = 'MIT'
Expand Down

0 comments on commit f7bbdfc

Please sign in to comment.