Merge pull request #28 from lektor/feature/documentation
Feature/documentation
This commit is contained in:
commit
3a228fb23f
|
@ -55,7 +55,7 @@ potential deployment target add a `[servers.NAME]` section. The supported
|
|||
keys are `name` for an optional human readable name of the server, `enabled` to
|
||||
enable or disable it (defaults to `true`) and `target` which is the URL to
|
||||
publish to. Additionally one of the servers can have `default` set to `yes`
|
||||
to set it as default. Here an example:
|
||||
to set it as default. Here is an example:
|
||||
|
||||
```ini
|
||||
[servers.production]
|
||||
|
@ -95,7 +95,7 @@ you keep your project file secure as loss of the project file can mean that
|
|||
people get access to your server. Alternatively you can also provide username
|
||||
and password through the command line of environment variables.
|
||||
|
||||
The following targets are supported for the `target` folder:
|
||||
The following targets are supported for the `target` field:
|
||||
|
||||
* [rsync](rsync/)
|
||||
* [FTP](ftp/)
|
||||
|
|
|
@ -57,7 +57,7 @@ configure the access credentials. We will get to that.
|
|||
|
||||
## Enabling Travis
|
||||
|
||||
So now that we have all that configured we need to tellt travis to build the
|
||||
So now that we have all that configured we need to tell travis to build the
|
||||
repository. For that just head to your [Travis-CI Profile
|
||||
:ext](https://travis-ci.org/profile) and enable the repository. If it does not
|
||||
show up yet, you can force a sync with the click of a button.
|
||||
|
|
|
@ -122,7 +122,7 @@ do:
|
|||
{% extends "layout.html" %}
|
||||
{% block title %}{{ this.title }} | My Blog{% endblock %}
|
||||
{% block body %}
|
||||
<1h>{{ this.title }}
|
||||
<h1>{{ this.title }}
|
||||
<p class="meta">
|
||||
by {{ this.author }}
|
||||
on {{ this.pub_date|dateformat('full') }}
|
||||
|
@ -141,7 +141,7 @@ with the name of your blog. For instance just `content/blog` and put a
|
|||
_model: blog
|
||||
```
|
||||
|
||||
Now you can head to the admin to create new blog posts.
|
||||
Now you can head to the admin UI to create new blog posts.
|
||||
|
||||
## Changing the URL Structure
|
||||
|
||||
|
|
|
@ -63,7 +63,7 @@ source = site.query('/project-categories')
|
|||
```
|
||||
|
||||
The above models should be mostly clear. What is probably not entirely clear
|
||||
is the `source` parameter for the categories. Esentially we instruct the
|
||||
is the `source` parameter for the categories. Essentially we instruct the
|
||||
admin panel to fill the selection for the checkboxes from the child pages
|
||||
below the `project-categories` folder. This is where we will maintain the
|
||||
categories.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
title: Pagination
|
||||
---
|
||||
summary: Shows how to build a pagination with Lektor
|
||||
summary: Shows how to build a pagination with Lektor.
|
||||
---
|
||||
body:
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ assume we build a website for someone who wants to showcase their art projects.
|
|||
## The Models
|
||||
|
||||
The way we want to go about this is that we have a site where all the
|
||||
projects shows up and then a detail page for each project in particular.
|
||||
projects show up and then a detail page for each project in particular.
|
||||
|
||||
### `projects.ini`
|
||||
|
||||
|
@ -23,7 +23,7 @@ for new pages and make it impossible to delete (`protected`). This means we
|
|||
need to manually create the one page later which will use this.
|
||||
|
||||
Because we only have a single page for the projects overview we give it a
|
||||
label manually (`label = Projects`).
|
||||
static label manually (`label = Projects`).
|
||||
|
||||
```ini
|
||||
[model]
|
||||
|
@ -135,7 +135,7 @@ For the detail page we show all information we know about:
|
|||
</dl>
|
||||
<h2>Description</h2>
|
||||
<div class="description">{{ this.description }}</div>
|
||||
{% set images = project.attachments.images.all() %}
|
||||
{% set images = this.attachments.images.all() %}
|
||||
{% if images %}
|
||||
<h2>Images</h2>
|
||||
{% for image in images %}
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
title: Single-Page
|
||||
---
|
||||
summary: Some inspiration of how to structure single page apps.
|
||||
summary: Some inspiration for structuring single page apps.
|
||||
---
|
||||
body:
|
||||
|
||||
|
@ -110,7 +110,7 @@ need to query for all the other pages we have below `doc/`:
|
|||
{% block body %}
|
||||
{% set pages = site.query('/doc').all() %}
|
||||
<header>
|
||||
<h1>{{ this.title }}</h2>
|
||||
<h1>{{ this.title }}</h1>
|
||||
<nav>
|
||||
<ul>
|
||||
{% for page in pages %}
|
||||
|
|
|
@ -46,7 +46,7 @@ skips hidden pages so those will not be generated out.
|
|||
Note that because sitemaps need to have external URLs (with scheme and
|
||||
everything) you will need to configure the `url` of the site before the
|
||||
template starts working. For more information see [Project File
|
||||
:ref](../../project/)
|
||||
:ref](../../project/file/#[project])
|
||||
|
||||
## Human Readable Sitemap
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
title: Webpack
|
||||
---
|
||||
summary: Shows how to use webpack to Sass, Less or other things with Lektor.
|
||||
summary: Shows how to use webpack to do Sass, Less or other things with Lektor.
|
||||
---
|
||||
body:
|
||||
|
||||
|
@ -43,7 +43,7 @@ start is to create an almost empty file:
|
|||
}
|
||||
```
|
||||
|
||||
Now we can npm install all the things we want:
|
||||
Now we can `npm install` all the things we want:
|
||||
|
||||
```
|
||||
$ npm install --save-dev webpack babel-core node-sass babel-loader sass-loader css-loader url-loader style-loader file-loader
|
||||
|
@ -51,7 +51,7 @@ $ npm install --save-dev webpack babel-core node-sass babel-loader sass-loader c
|
|||
|
||||
This will install webpack itself together with babel and sass as well as
|
||||
a bunch of loaders we need for getting all that configured. Because we
|
||||
created a `package.json` before and we use `--save-dev` the dependencies
|
||||
created a `package.json` before and we used `--save-dev` the dependencies
|
||||
will be remembered in the `package.json` file.
|
||||
|
||||
### `webpack.config.js`
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
title: Howto
|
||||
title: How To
|
||||
---
|
||||
summary: Covers the most common things plugins would do and how to implement it.
|
||||
---
|
||||
|
|
Loading…
Reference in New Issue