OLD | NEW |
(Empty) | |
| 1 // === Overview === |
| 2 // |
| 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. |
| 5 // |
| 6 // === Format === |
| 7 // |
| 8 // Each entry declares a rule with: |
| 9 // * An arbitrary identifier key e.g. "cr-extensions-examples". |
| 10 // * What URL the rule should be invoked with, given by "serveFrom", e.g. |
| 11 // "extensions/examples". |
| 12 // * An object describing where the content originates; currently the only |
| 13 // supported location is "chromium" with a key "dir" specifying which |
| 14 // chromium directory to look in, e.g. "extensions/samples". |
| 15 // |
| 16 // In this example, when the user navigates to |
| 17 // |
| 18 // developer.chrome.com/extensions/examples/some/sample/path |
| 19 // |
| 20 // then |
| 21 // 1. The "cr-extensions-examples" rule is invoked (since it's served from |
| 22 // "extensions/examples"). |
| 23 // 2. The docserver will look up the path "docs/examples/some/sample/path" |
| 24 // in chromium - the URL after the "serveFrom" path (some/sample/path) |
| 25 // prefixed by the chromium directory (docs/examples). |
| 26 // 3. Then render and serve it. |
| 27 // |
| 28 // === Special properties === |
| 29 // |
| 30 // There are some other properties that can be specified: |
| 31 // * "supportsZip" indicates whether directories are allowed to be served as |
| 32 // zip files. For safety this isn't supported for arbitrary URLs, only those |
| 33 // within a rule that has "supportsZip": true. |
| 34 // * "supportsTemplates" indicates whether HTML files should be treated and |
| 35 // renderered as templates, versus just plain text. Complex documentation |
| 36 // which interacts with docserver features (like API listing) need to set |
| 37 // this to true. Otherwise, it's safer and more efficient to omit it. |
| 38 |
| 39 { |
| 40 "cr-extensions-examples": { |
| 41 "chromium": { |
| 42 "dir": "docs/examples" |
| 43 }, |
| 44 "serveFrom": "extensions/examples", |
| 45 "supportsZip": true |
| 46 }, |
| 47 "cr-public": { |
| 48 "chromium": { |
| 49 "dir": "docs/templates/public" |
| 50 }, |
| 51 "serveFrom": "", |
| 52 "supportsTemplates": true |
| 53 }, |
| 54 "cr-static": { |
| 55 "chromium": { |
| 56 "dir": "docs/static" |
| 57 }, |
| 58 "serveFrom": "static" |
| 59 } |
| 60 } |
OLD | NEW |