OLD | NEW |
1 -------- | 1 -------- |
2 Overview | 2 Overview |
3 | 3 |
4 This is the content and its server for the extensions/apps documentation served | 4 This is the content and its server for the extensions/apps documentation served |
5 from http://developer.chrome.com/(extensions|apps). | 5 from http://developer.chrome.com/(extensions|apps). |
6 | 6 |
7 Documentation for apps and extensions are partly generated from API definitions | 7 Documentation for apps and extensions are partly generated from API definitions |
8 (for the reference material), and partly hand-written. | 8 (for the reference material), and partly hand-written. |
9 | 9 |
10 All documentation sources are checked into source control, just like any other | 10 All documentation sources are checked into source control, just like any other |
(...skipping 28 matching lines...) Expand all Loading... |
39 - If you are not updating the static HTML for a docs page, you will most | 39 - If you are not updating the static HTML for a docs page, you will most |
40 likely not have to do anything. The docs server will automatically pick | 40 likely not have to do anything. The docs server will automatically pick |
41 up changes to the JSON or IDL schemas. | 41 up changes to the JSON or IDL schemas. |
42 | 42 |
43 - Otherwise, they will be in chrome/common/extensions/docs/templates/. | 43 - Otherwise, they will be in chrome/common/extensions/docs/templates/. |
44 See the "Overview of directories" section for more information. | 44 See the "Overview of directories" section for more information. |
45 Chances are you'll want to change a file in either "intros" (if changing | 45 Chances are you'll want to change a file in either "intros" (if changing |
46 API documentation) or "articles" (if changing non-API documentation). | 46 API documentation) or "articles" (if changing non-API documentation). |
47 If adding files or APIs you'll also need to add something to "public". | 47 If adding files or APIs you'll also need to add something to "public". |
48 | 48 |
49 - Files in templates directory use the Handlebar template language. It is | 49 - Files in templates directory use the Motemplate template language. It is |
50 extremely simple, essentially: write HTML. | 50 extremely simple, essentially: write HTML. |
51 See third_party/handlebar/README.md. | 51 See third_party/motemplate/README.md. |
52 | 52 |
53 - static/css/out/site.css is generated by compiling static/sass/*.scss | 53 - static/css/out/site.css is generated by compiling static/sass/*.scss |
54 files. Don't change site.css directly. Instead, change the *.scss files | 54 files. Don't change site.css directly. Instead, change the *.scss files |
55 and run compass from this (docs/) directory: | 55 and run compass from this (docs/) directory: |
56 compass compile . | 56 compass compile . |
57 See http://compass-style.org/install to install compass. | 57 See http://compass-style.org/install to install compass. |
58 See https://codereview.chromium.org/238303002/#msg6 for configuration | 58 See https://codereview.chromium.org/238303002/#msg6 for configuration |
59 information (config.rb). | 59 information (config.rb). |
60 | 60 |
61 2. Run 'server2/preview.py' | 61 2. Run 'server2/preview.py' |
(...skipping 27 matching lines...) Expand all Loading... |
89 pages. | 89 pages. |
90 - articles: The static content that appears on non-API pages. | 90 - articles: The static content that appears on non-API pages. |
91 - public: The top level templates for all pages. | 91 - public: The top level templates for all pages. |
92 - private: Helper templates used in rendering the docs. | 92 - private: Helper templates used in rendering the docs. |
93 | 93 |
94 | 94 |
95 -------------------- | 95 -------------------- |
96 The AppEngine server | 96 The AppEngine server |
97 | 97 |
98 See server2/README. | 98 See server2/README. |
OLD | NEW |