You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: configuration/index.md
+14-5Lines changed: 14 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,13 +37,16 @@ Here is the available configuration that does not depend on the theme whatsoever
37
37
38
38
## Package
39
39
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).
41
42
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
44
47
* an absolute path.
45
48
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):
47
50
48
51
*`title`: human name of your project
49
52
*`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
52
55
*`homepage`: URL to your project's homepage
53
56
*`description`: description of your project
54
57
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
+
<pclass="note note--info">
59
+
A given path must be relative to the configuration file.
60
+
</p>
61
+
62
+
<pclass="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.
0 commit comments