Skip to content

Commit 2c4b709

Browse files
committed
Clarify package configuration
- Refs SassDoc/sassdoc#284
1 parent df78a2a commit 2c4b709

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

configuration/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,16 @@ Here is the available configuration that does not depend on the theme whatsoever
3737

3838
## Package
3939

40-
The `package` option is either a string to a JSON file containing information about the documented project (for instance a `package.json`, hence the name of the key), or directly an object. Please know that we try to find it in 3 different locations before giving up:
40+
The `package` option is either a path (String) to a JSON file or directly an Object.
41+
It contains information about the documented project (for instance a `package.json`, hence the name of the key).
4142

42-
* a relative path from your current folder,
43-
* a relative path from the theme folder,
43+
Please note that we try to find a `package.json` in 3 different locations before giving up:
44+
45+
* a relative path from your current folder
46+
* a relative path from the theme folder
4447
* an absolute path.
4548

46-
If this doesn't work for you, then you can set your own package. The package object (either direct or required from a path) should ideally contain (so the theme can access to various information about your project):
49+
If this doesn't work for you, then you can set your own package. The package object (either direct or required from a path) should ideally contain (for the theme to access to various information about your project):
4750

4851
* `title`: human name of your project
4952
* `name`: package name of your project (in case `title` is not defined)
@@ -52,7 +55,13 @@ If this doesn't work for you, then you can set your own package. The package obj
5255
* `homepage`: URL to your project's homepage
5356
* `description`: description of your project
5457

55-
Note that if you set this option as a path to a JSON file, we will override it with the content of this JSON file so once in the view, `package` will no longer contain a string, but an object.
58+
<p class="note note--info">
59+
A given path must be relative to the configuration file.
60+
</p>
61+
62+
<p class="note note--info">
63+
Note that if you set this option as a path to a JSON file, we will override it with the content of this JSON file once in the view, thus `package` will no longer contain a string, but an object.
64+
</p>
5665

5766
## Theme
5867

0 commit comments

Comments
 (0)