Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(3)

Unified Diff: site/dev/tools/markdown.md

Issue 976303002: Add some METADATA files to control docs layout. (Closed) Base URL: https://skia.googlesource.com/skia.git@master
Patch Set: Created 5 years, 10 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « site/METADATA ('k') | site/user/METADATA » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: site/dev/tools/markdown.md
diff --git a/site/dev/tools/markdown.md b/site/dev/tools/markdown.md
index ffdff4b576ecc0a0eca6b2793a10d334af647c63..e624a27239653318969fbd69efa4a2bab184ae2d 100644
--- a/site/dev/tools/markdown.md
+++ b/site/dev/tools/markdown.md
@@ -34,6 +34,26 @@ the --port flag:
docserver --preview --port=:8002
+METADATA
+--------
+
+By default all files and directories that appear in the same level are sorted
+alphabetically by file name in the navigation menu, with files appearing
+before directories. You can override this default behavior by adding a
+METADATA file to a directory. A METADATA file is a JSON file of the following
+format:
+
+~~~~
+ {
+ "dirOrder": ["sample", "quick", "special"],
+ "fileOrder": ["download", "api"]
+ }
+~~~~
+
+If a file or directory doesn't appear in `dirOrder` or `fileOrder` then it is sorted
+to appear after the members of `dirOrder` or `fileOrder` respectively. All
+files and directories that aren't controlled by a METADATA file are sorted in
+alphabetical order by their filename.
Some Example MarkDown
---------------------
« no previous file with comments | « site/METADATA ('k') | site/user/METADATA » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698