Merge pull request #278 from andradei/master
Fix documentation typos and minor changes:
This commit is contained in:
commit
9d2f6f0b23
|
@ -27,7 +27,7 @@ Each page path (the part after the `base_url`, for example `blog/cli-usage/`) ca
|
||||||
attribute of the [page front-matter](./documentation/content/page.md#front-matter).
|
attribute of the [page front-matter](./documentation/content/page.md#front-matter).
|
||||||
|
|
||||||
You might have noticed a file named `_index.md` in the example above.
|
You might have noticed a file named `_index.md` in the example above.
|
||||||
This file will be used for the metadata and content of the section itself and is not considered a page.
|
This file is used to store both metadata and content of the section itself and is not considered a page.
|
||||||
|
|
||||||
To make sure the terminology used in the rest of the documentation is understood, let's go over the example above.
|
To make sure the terminology used in the rest of the documentation is understood, let's go over the example above.
|
||||||
|
|
||||||
|
|
|
@ -3,12 +3,10 @@ title = "Section"
|
||||||
weight = 20
|
weight = 20
|
||||||
+++
|
+++
|
||||||
|
|
||||||
A section is automatically created when a folder is found
|
A section is automatically created when a folder is found in the `content` section, unless it only
|
||||||
in the `content` section, unless it only contains a `index.md` file and is actually
|
contains a `index.md` file and is actually a page with assets.
|
||||||
a page with assets.
|
|
||||||
|
|
||||||
You can add `_index.md` file to a folder to augment a section and give it
|
You can add `_index.md` file to a folder to augment a section and give it some metadata and/or content.
|
||||||
some metadata and/or content.
|
|
||||||
|
|
||||||
The index page is actually a section created automatically like any other: you can add metadata
|
The index page is actually a section created automatically like any other: you can add metadata
|
||||||
and content by adding `_index.md` at the root of the `content` folder.
|
and content by adding `_index.md` at the root of the `content` folder.
|
||||||
|
@ -18,7 +16,7 @@ and content by adding `_index.md` at the root of the `content` folder.
|
||||||
The front-matter is a set of metadata embedded in a file. In Gutenberg,
|
The front-matter is a set of metadata embedded in a file. In Gutenberg,
|
||||||
it is at the beginning of the file, surrounded by `+++` and uses TOML.
|
it is at the beginning of the file, surrounded by `+++` and uses TOML.
|
||||||
|
|
||||||
While none of the front-matter variables are mandatory, the the opening and closing `+++` are required.
|
While none of the front-matter variables are mandatory, the opening and closing `+++` are required.
|
||||||
|
|
||||||
Here is an example `_index.md` with all the variables available:
|
Here is an example `_index.md` with all the variables available:
|
||||||
|
|
||||||
|
@ -33,7 +31,7 @@ description = ""
|
||||||
sort_by = "none"
|
sort_by = "none"
|
||||||
|
|
||||||
# Used by the parent section to order its subsections.
|
# Used by the parent section to order its subsections.
|
||||||
# Higher values means it will be at the end.
|
# Lower values have priority.
|
||||||
weight = 0
|
weight = 0
|
||||||
|
|
||||||
# Template to use to render this section page
|
# Template to use to render this section page
|
||||||
|
@ -81,7 +79,7 @@ To enable pagination for a section's pages, simply set `paginate_by` to a positi
|
||||||
paginate by this much. See [pagination template documentation](./documentation/templates/pagination.md) for more information
|
paginate by this much. See [pagination template documentation](./documentation/templates/pagination.md) for more information
|
||||||
on what will be available in the template.
|
on what will be available in the template.
|
||||||
|
|
||||||
You can also change the pagination path - the word displayed while paginated in the URL, like `page/1` -
|
You can also change the pagination path (the word displayed while paginated in the URL, like `page/1`)
|
||||||
by setting the `paginate_path` variable, which defaults to `page`.
|
by setting the `paginate_path` variable, which defaults to `page`.
|
||||||
|
|
||||||
## Sorting
|
## Sorting
|
||||||
|
|
|
@ -74,34 +74,34 @@ ignored_content = []
|
||||||
|
|
||||||
Gutenberg currently has the following highlight themes available:
|
Gutenberg currently has the following highlight themes available:
|
||||||
|
|
||||||
- 1337: https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337
|
- [1337](https://tmtheme-editor.herokuapp.com/#!/editor/theme/1337)
|
||||||
- agola-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark
|
- [agola-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Agola%20Dark)
|
||||||
- ascetic-white: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White
|
- [ascetic-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Ascetic%20White)
|
||||||
- axar: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar
|
- [axar](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Axar)
|
||||||
- base16-ocean-dark
|
- base16-ocean-dark
|
||||||
- base16-ocean-light
|
- base16-ocean-light
|
||||||
- bbedit: https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit
|
- [bbedit](https://tmtheme-editor.herokuapp.com/#!/editor/theme/BBEdit)
|
||||||
- boron: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron
|
- [boron](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Boron)
|
||||||
- charcoal: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal
|
- [charcoal](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Charcoal)
|
||||||
- cheerfully-light: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light
|
- [cheerfully-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Cheerfully%20Light)
|
||||||
- classic-modified: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified
|
- [classic-modified](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Classic%20Modified)
|
||||||
- demain: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain
|
- [demain](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Demain)
|
||||||
- dimmed-fluid: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid
|
- [dimmed-fluid](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Dimmed%20Fluid)
|
||||||
- gray-matter-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark
|
- [gray-matter-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Gray%20Matter%20Dark)
|
||||||
- gruvbox-dark: https://github.com/morhetz/gruvbox
|
- [gruvbox-dark](https://github.com/morhetz/gruvbox)
|
||||||
- gruvbox-light: https://github.com/morhetz/gruvbox
|
- [gruvbox-light](https://github.com/morhetz/gruvbox)
|
||||||
- idle: https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE
|
- [idle](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IDLE)
|
||||||
- inspired-github: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub
|
- [inspired-github](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Inspiredgithub)
|
||||||
- ir-white: https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White
|
- [ir-white](https://tmtheme-editor.herokuapp.com/#!/editor/theme/IR_White)
|
||||||
- kronuz: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz
|
- [kronuz](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Kronuz)
|
||||||
- material-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark
|
- [material-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Material%20Dark)
|
||||||
- material-light: https://github.com/morhetz/gruvbox
|
- [material-light](https://github.com/morhetz/gruvbox)
|
||||||
- monokai: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai
|
- [monokai](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Monokai)
|
||||||
- solarized-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark)
|
- [solarized-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(dark))
|
||||||
- solarized-light: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light)
|
- [solarized-light](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Solarized%20(light))
|
||||||
- subway-madrid: https://github.com/idleberg/Subway.tmTheme
|
- [subway-madrid](https://github.com/idleberg/Subway.tmTheme)
|
||||||
- subway-moscow: https://github.com/idleberg/Subway.tmTheme
|
- [subway-moscow](https://github.com/idleberg/Subway.tmTheme)
|
||||||
- visual-studio-dark: https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark
|
- [visual-studio-dark](https://tmtheme-editor.herokuapp.com/#!/editor/theme/Visual%20Studio%20Dark)
|
||||||
|
|
||||||
Gutenberg uses the Sublime Text themes, making it very easy to add more.
|
Gutenberg uses the Sublime Text themes, making it very easy to add more.
|
||||||
If you want a theme not on that list, please open an issue or a pull request on the [Gutenberg repo](https://github.com/Keats/gutenberg).
|
If you want a theme not on that list, please open an issue or a pull request on the [Gutenberg repo](https://github.com/Keats/gutenberg).
|
||||||
|
|
|
@ -25,7 +25,7 @@ A mandatory configuration file of Gutenberg in TOML format.
|
||||||
It is explained in details in the [Configuration page](./documentation/getting-started/configuration.md).
|
It is explained in details in the [Configuration page](./documentation/getting-started/configuration.md).
|
||||||
|
|
||||||
## `content`
|
## `content`
|
||||||
Where all your markup content lies: this will most likely be mostly `.md` files.
|
Where all your markup content lies: this will be mostly comprised of `.md` files.
|
||||||
Each folder in the `content` directory represents a [section](./documentation/content/section.md)
|
Each folder in the `content` directory represents a [section](./documentation/content/section.md)
|
||||||
that contains [pages](./documentation/content/page.md) : your `.md` files.
|
that contains [pages](./documentation/content/page.md) : your `.md` files.
|
||||||
|
|
||||||
|
@ -41,9 +41,9 @@ Contains any kind of files. All the files/folders in the `static` folder will be
|
||||||
|
|
||||||
## `templates`
|
## `templates`
|
||||||
Contains all the [Tera](https://tera.netlify.com) templates that will be used to render this site.
|
Contains all the [Tera](https://tera.netlify.com) templates that will be used to render this site.
|
||||||
Have a look at the [Templates](./documentation/templates/_index.md) to learn more on the default templates
|
Have a look at the [Templates](./documentation/templates/_index.md) to learn more about default templates
|
||||||
and the variables available.
|
and available variables.
|
||||||
|
|
||||||
## `themes`
|
## `themes`
|
||||||
Contains themes that can be used for that site. If you are not planning to use themes, you can safely ignore
|
Contains themes that can be used for that site. If you are not planning to use themes, leave this folder empty.
|
||||||
this folder and let it be. If you want to learn about themes, head to the [themes documentation](./documentation/themes/_index.md).
|
If you want to learn about themes, head to the [themes documentation](./documentation/themes/_index.md).
|
||||||
|
|
|
@ -51,7 +51,7 @@ to be able to build the theme from your repository.
|
||||||
|
|
||||||
### Caveat
|
### Caveat
|
||||||
|
|
||||||
Please note that [include paths](https://tera.netlify.com/docs/templates/#include) can only be used in used in normal templates.
|
Please note that [include paths](https://tera.netlify.com/docs/templates/#include) can only be used in normal templates.
|
||||||
Theme templates should use [macros](https://tera.netlify.com/docs/templates/#macros) instead.
|
Theme templates should use [macros](https://tera.netlify.com/docs/templates/#macros) instead.
|
||||||
|
|
||||||
## Submitting a theme to the gallery
|
## Submitting a theme to the gallery
|
||||||
|
|
Loading…
Reference in a new issue