Skip to content

Commit

Permalink
Update generator Project config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffreymcgill committed Jul 24, 2023
1 parent d28444a commit 1f5f03d
Showing 1 changed file with 65 additions and 0 deletions.
65 changes: 65 additions & 0 deletions configuration/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,71 @@ footer:
## generator
### directoryIndex
Configuration options to instruct Retype on how and when to deal with the default directory index files, such as `index.html`.
### directoryIndex.altNames
=== directoryIndex.altNames : `list`
A list of alternative default HTML document file names.
By default, Retype uses the following list of `altNames`:
```yml
generator:
directoryIndex:
altNames:
- index.html
- index.htm
- default.html
- default.htm
```
===
### directoryIndex.append
=== directoryIndex.append : `boolean`
Specifies if the default document file name should be appended to resolved URLs. By default, Retype does not append the default file name.
If `false`, the generated link will be `/guide/`. If `true`, the generated link will be `/guides/index.html`.
```yml
generator:
directoryIndex:
append: true # default is false
```
===
### directoryIndex.name
=== directoryIndex.name : `string`
The default HTML document file name generated by Retype.
```yml
generator:
directoryIndex:
name: default.htm # Default is index.html
```
===
### paths
=== paths : `string`
Configures url kind preference for resolved urls. Supported values: `source`, `relative`, and `root`.
Option | Description
--- | ---
`relative` | Link paths are constructed using relative paths. Example: `../../guide/introduction/`. This is the default.
`root` | Link paths are constructed using paths resolving to the website root. Example: `/guide/introduction/`
`source` | Link paths are constructed using paths resolving to the source file root.
```yml
generator:
paths: relative
```
===
### recase
=== recase : `string`
Expand Down

0 comments on commit 1f5f03d

Please sign in to comment.