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": { | 44 "cr-chrome-docs-home": { |
45 // "chromium": { | 45 "chromium": { |
46 // "dir": "chrome/docs" | 46 "dir": "chrome/docs" |
47 // }, | 47 }, |
48 // "defaultExtensions": [".html", ".md"], | 48 "defaultExtensions": [".html", ".md"], |
49 // "serveFrom": "home", | 49 "serveFrom": "home", |
50 // "supportsTemplates": true | 50 "supportsTemplates": true |
51 //}, | 51 }, |
52 "cr-extensions-examples": { | 52 "cr-extensions-examples": { |
53 "chromium": { | 53 "chromium": { |
54 "dir": "chrome/common/extensions/docs/examples" | 54 "dir": "chrome/common/extensions/docs/examples" |
55 }, | 55 }, |
56 "serveFrom": "extensions/examples", | 56 "serveFrom": "extensions/examples", |
57 "supportsZip": true | 57 "supportsZip": true |
58 }, | 58 }, |
59 "cr-public": { | 59 "cr-public": { |
60 "chromium": { | 60 "chromium": { |
61 "dir": "chrome/common/extensions/docs/templates/public" | 61 "dir": "chrome/common/extensions/docs/templates/public" |
62 }, | 62 }, |
63 "defaultExtensions": [".html", ".md"], | 63 "defaultExtensions": [".html", ".md"], |
64 "serveFrom": "", | 64 "serveFrom": "", |
65 "supportsTemplates": true | 65 "supportsTemplates": true |
66 }, | 66 }, |
67 "cr-static": { | 67 "cr-static": { |
68 "chromium": { | 68 "chromium": { |
69 "dir": "chrome/common/extensions/docs/static" | 69 "dir": "chrome/common/extensions/docs/static" |
70 }, | 70 }, |
71 "serveFrom": "static" | 71 "serveFrom": "static" |
| 72 }, |
| 73 "cr-native-client": { |
| 74 "chromium": { |
| 75 "dir": "native_client_sdk/doc_generated" |
| 76 }, |
| 77 "defaultExtensions": [".html", ".md"], |
| 78 "serveFrom": "native-client", |
| 79 "supportsTemplates": true |
| 80 }, |
| 81 "devtools-docs": { |
| 82 "defaultExtensions": [".html", ".md"], |
| 83 "gcs": { |
| 84 "bucket": "gs://chromedocs-devtools" |
| 85 }, |
| 86 "serveFrom": "devtools", |
| 87 "supportsTemplates": true |
| 88 }, |
| 89 "multidevice-docs": { |
| 90 "defaultExtensions": [".html", ".md"], |
| 91 "gcs": { |
| 92 "bucket": "gs://chromedocs-multidevice" |
| 93 }, |
| 94 "serveFrom": "multidevice", |
| 95 "supportsTemplates": true |
| 96 }, |
| 97 "webstore-docs": { |
| 98 "defaultExtensions": [".html", ".md"], |
| 99 "gcs": { |
| 100 "bucket": "gs://chromedocs-webstore" |
| 101 }, |
| 102 "serveFrom": "webstore", |
| 103 "supportsTemplates": true |
72 } | 104 } |
73 //"cr-native-client": { | |
74 // "chromium": { | |
75 // "dir": "native_client_sdk/doc_generated" | |
76 // }, | |
77 // "defaultExtensions": [".html", ".md"], | |
78 // "serveFrom": "native-client", | |
79 // "supportsTemplates": true | |
80 //}, | |
81 //"devtools-docs": { | |
82 // "defaultExtensions": [".html", ".md"], | |
83 // "gcs": { | |
84 // "bucket": "gs://chromedocs-devtools" | |
85 // }, | |
86 // "serveFrom": "devtools", | |
87 // "supportsTemplates": true | |
88 //}, | |
89 //"multidevice-docs": { | |
90 // "defaultExtensions": [".html", ".md"], | |
91 // "gcs": { | |
92 // "bucket": "gs://chromedocs-multidevice" | |
93 // }, | |
94 // "serveFrom": "multidevice", | |
95 // "supportsTemplates": true | |
96 //}, | |
97 //"webstore-docs": { | |
98 // "defaultExtensions": [".html", ".md"], | |
99 // "gcs": { | |
100 // "bucket": "gs://chromedocs-webstore" | |
101 // }, | |
102 // "serveFrom": "webstore", | |
103 // "supportsTemplates": true | |
104 //} | |
105 } | 105 } |
OLD | NEW |