Skip to content
Sam Richard edited this page May 2, 2015 · 3 revisions

Basic rules for Generating a URL

  • All URLs are dasherized and slugified
  • Main sections URLs (/principles, /guidelines, etc…) redirect to first section's first piece of content (/principles goes to /principles/introduce-cognitive, /guidelines goes to /guidelines/style/accessibility, etc…)
  • Sub Section URLs (/guidelines/style, /ui-patterns/documentation) redirect to that section's first piece of content (/guidelines/style goes to /guidelines/style/accessibility, /ui-patterns/documentation goes to /ui-patterns/documentation/getting-started, etc…)
  • No URLs should point to .html files; they should all point to folders with an index.html file in them (they should all be Semantic URLs

Folder Structure for language section

The folder structure in the language section will determine what main and sub sections will be generated. Any folder that contains .md or .html files will generated and become part of the URL structure. With the exception of the home page (language/index.html), the 404 page (language/404.md), and individual pattern pages, all long-form text or pages should live inside a sub folder of a main section folder in the language section of this repository and be titled either index.html or index.md.

Main section, sub section, and sub section item order is determined alphabetically. Numbers can be prepended (01-guidelines, 02-principles, etc…) to manually control the order with which they are ordered, with any unnumbered items being ordered alphabetically after. Numbers that are prepended will not be included in the final URL structure and are only used for ordering.