Move configuration documentation to a separate page Add a new "Configuration" page. Move the existing documentation out of the Markdown page. Link to the new configuration documentation from the navbar, and add a brief paragraph about it in README. Change-Id: I76de97bcd459d55cc46fa8d6c6da9be1202c1297
diff --git a/Documentation/config.md b/Documentation/config.md new file mode 100644 index 0000000..2779dd7 --- /dev/null +++ b/Documentation/config.md
@@ -0,0 +1,49 @@ +# Configuration + +The `gitiles.config` file supporting the site contains several configuration +options. + +[TOC] + +## Markdown + +### Disabling markdown + +Markdown can be completely disabled by setting render to false. + +``` +[markdown] + render = false +``` + +### Markdown size + +Markdown files are limited by default to 5 MiB of input text +per file. This limit is configurable, but should not be raised +beyond available memory. + +``` +[markdown] + inputLimit = 5M +``` + +### Image size + +Referenced [images are inlined](#Images) as base64 encoded URIs. +The image limit places an upper bound on the byte size of input. + +``` +[markdown] + imageLimit = 256K +``` + +## Google Analytics + +[Google Analytics](https://www.google.com/analytics/) can be +enabled on every rendered markdown page by adding the Property ID +to the configuration file: + +``` +[google] + analyticsId = UA-XXXX-Y +```
diff --git a/Documentation/markdown.md b/Documentation/markdown.md index 3e0f392..fdd34a9 100644 --- a/Documentation/markdown.md +++ b/Documentation/markdown.md
@@ -703,45 +703,5 @@ ## Configuration The `gitiles.config` file supporting the site contains several -configuration options that impact markdown rendering. - -### Disabling markdown - -Markdown can be completely disabled by setting render to false. - -``` -[markdown] - render = false -``` - -### Markdown size - -Markdown files are limited by default to 5 MiB of input text -per file. This limit is configurable, but should not be raised -beyond available memory. - -``` -[markdown] - inputLimit = 5M -``` - -### Image size - -Referenced [images are inlined](#Images) as base64 encoded URIs. -The image limit places an upper bound on the byte size of input. - -``` -[markdown] - imageLimit = 256K -``` - -### Google Analytics - -[Google Analytics](https://www.google.com/analytics/) can be -enabled on every rendered markdown page by adding the Property ID -to the configuration file: - -``` -[google] - analyticsId = UA-XXXX-Y -``` +configuration options that impact markdown rendering. Refer to the +[configuration documentation](config.md#Markdown) for details.
diff --git a/README.md b/README.md index 3bbfb98..4bb030d 100644 --- a/README.md +++ b/README.md
@@ -8,6 +8,12 @@ documentation. Refer to the [Markdown documentation](/Documentation/markdown.md) for details. +## Configuration + +Gitiles is configurable in a git-style configuration file named +`gitiles.config`. Refer to the [configuration documentation](/Documentation/config.md) +for details. + ## Contributing to Gitiles Please refer to the [Developer Guide](/Documentation/developer-guide.md).
diff --git a/navbar.md b/navbar.md index dde7a44..608531c 100644 --- a/navbar.md +++ b/navbar.md
@@ -1,3 +1,4 @@ * [Home](/README.md) * [Markdown](/Documentation/markdown.md) +* [Configuration](/Documentation/config.md) * [Developers](/Documentation/developer-guide.md)