OLD | NEW |
1 // === Overview === | 1 // === Overview === |
2 // | 2 // |
3 // This file configures where to find and how to serve content in the docserver. | 3 // This file configures where to find and how to serve content in the docserver. |
4 // It's the most fundamentally important file in all of the docserver. | 4 // It's the most fundamentally important file in all of the docserver. |
5 // | 5 // |
6 // === Format === | 6 // === Format === |
7 // | 7 // |
8 // Each entry declares a rule with: | 8 // Each entry declares a rule with: |
9 // * An arbitrary identifier key e.g. "cr-extensions-examples". | 9 // * An arbitrary identifier key e.g. "cr-extensions-examples". |
10 // * What URL the rule should be invoked with, given by "serveFrom", e.g. | 10 // * What URL the rule should be invoked with, given by "serveFrom", e.g. |
(...skipping 23 matching lines...) Expand all Loading... |
34 // There are some other properties that can be specified: | 34 // There are some other properties that can be specified: |
35 // * "supportsZip" indicates whether directories are allowed to be served as | 35 // * "supportsZip" indicates whether directories are allowed to be served as |
36 // zip files. For safety this isn't supported for arbitrary URLs, only those | 36 // zip files. For safety this isn't supported for arbitrary URLs, only those |
37 // within a rule that has "supportsZip": true. | 37 // within a rule that has "supportsZip": true. |
38 // * "supportsTemplates" indicates whether HTML files should be treated and | 38 // * "supportsTemplates" indicates whether HTML files should be treated and |
39 // renderered as templates, versus just plain text. Complex documentation | 39 // renderered as templates, versus just plain text. Complex documentation |
40 // which interacts with docserver features (like API listing) need to set | 40 // which interacts with docserver features (like API listing) need to set |
41 // this to true. Otherwise, it's safer and more efficient to omit it. | 41 // this to true. Otherwise, it's safer and more efficient to omit it. |
42 | 42 |
43 { | 43 { |
| 44 "cr-chrome-docs-home": { |
| 45 "chromium": { |
| 46 "dir": "chrome/docs" |
| 47 }, |
| 48 "serveFrom": "home", |
| 49 "supportsTemplates": true |
| 50 }, |
44 "cr-extensions-examples": { | 51 "cr-extensions-examples": { |
45 "chromium": { | 52 "chromium": { |
46 "dir": "chrome/common/extensions/docs/examples" | 53 "dir": "chrome/common/extensions/docs/examples" |
47 }, | 54 }, |
48 "serveFrom": "extensions/examples", | 55 "serveFrom": "extensions/examples", |
49 "supportsZip": true | 56 "supportsZip": true |
50 }, | 57 }, |
51 "cr-public": { | 58 "cr-public": { |
52 "chromium": { | 59 "chromium": { |
53 "dir": "chrome/common/extensions/docs/templates/public" | 60 "dir": "chrome/common/extensions/docs/templates/public" |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
86 }, | 93 }, |
87 "webstore-docs": { | 94 "webstore-docs": { |
88 "github": { | 95 "github": { |
89 "owner": "GoogleChrome", | 96 "owner": "GoogleChrome", |
90 "repo": "webstore-docs" | 97 "repo": "webstore-docs" |
91 }, | 98 }, |
92 "serveFrom": "webstore", | 99 "serveFrom": "webstore", |
93 "supportsTemplates": true | 100 "supportsTemplates": true |
94 } | 101 } |
95 } | 102 } |
OLD | NEW |