From 29be11af06ebac002a671bd30437219da72439ff Mon Sep 17 00:00:00 2001 From: McSpider Date: Sat, 16 Nov 2013 19:42:36 -0800 Subject: [PATCH 1/7] Move a-lot of stuff around, add more navigation. --- src/_layouts/default.haml | 35 ++++++----- src/_partials/api_nav.haml | 8 +++ src/_partials/examples_sidebar.haml | 10 ++-- src/_partials/modules_sidebar.haml | 58 +++++++++---------- src/_partials/reference_sidebar.haml | 8 +-- src/_partials/sidebar.haml | 16 +++-- src/_partials/xml_nav.haml | 12 ++++ src/api/index.haml | 8 +++ src/api/reference/index.haml | 8 +++ src/css/style.css | 34 ++++++++++- src/index.haml | 22 +++++-- src/{modules => xml}/classes.haml | 2 +- src/{modules => xml}/disabledamage.haml | 2 +- src/{ => xml}/examples/eldritch.haml | 2 +- src/{ => xml}/examples/harb.haml | 2 +- .../examples/index.haml} | 2 +- src/{ => xml}/examples/rfv3.haml | 2 +- src/{ => xml}/examples/snowy_wars.haml | 2 +- src/{ => xml}/examples/viridun.haml | 2 +- src/{modules => xml}/filters.haml | 2 +- src/{modules => xml}/gamemode_blitz.haml | 2 +- src/{modules => xml}/gamemode_ctw.haml | 2 +- src/{modules => xml}/gamemode_dtc.haml | 2 +- src/{modules => xml}/gamemode_dtm.haml | 2 +- src/{modules => xml}/gamemode_other.haml | 2 +- src/{modules => xml}/gamemode_tdm.haml | 2 +- src/{modules => xml}/includes.haml | 2 +- src/{modules/main.haml => xml/index.haml} | 2 +- src/{modules.haml => xml/index2.haml} | 2 +- src/{modules => xml}/items.haml | 2 +- src/{modules => xml}/killreward.haml | 2 +- src/{modules => xml}/kits.haml | 2 +- src/{modules => xml}/lanes.haml | 2 +- src/{modules => xml}/mobs.haml | 2 +- src/{modules => xml}/other_settings.haml | 2 +- src/{modules => xml}/playable_region.haml | 2 +- src/{modules => xml}/portals.haml | 2 +- src/{modules => xml}/potions.haml | 2 +- src/{modules => xml}/projectiles.haml | 2 +- src/{ => xml}/reference/enchantments.haml | 2 +- src/{ => xml}/reference/formatting.haml | 2 +- .../reference/index.haml} | 2 +- src/{ => xml}/reference/inventory.haml | 2 +- src/{ => xml}/reference/potion_effects.haml | 2 +- src/{modules => xml}/regions.haml | 2 +- src/{modules => xml}/repair_remove.haml | 2 +- src/{modules => xml}/rules.haml | 2 +- src/{modules => xml}/score_boxes.haml | 2 +- src/{modules => xml}/spawns.haml | 2 +- src/{modules => xml}/teams.haml | 2 +- src/{modules => xml}/tnt.haml | 2 +- src/{modules => xml}/tutorial.haml | 2 +- 52 files changed, 197 insertions(+), 104 deletions(-) create mode 100644 src/_partials/api_nav.haml create mode 100644 src/_partials/xml_nav.haml create mode 100644 src/api/index.haml create mode 100644 src/api/reference/index.haml rename src/{modules => xml}/classes.haml (99%) rename src/{modules => xml}/disabledamage.haml (99%) rename src/{ => xml}/examples/eldritch.haml (99%) rename src/{ => xml}/examples/harb.haml (99%) rename src/{examples.haml => xml/examples/index.haml} (94%) rename src/{ => xml}/examples/rfv3.haml (99%) rename src/{ => xml}/examples/snowy_wars.haml (99%) rename src/{ => xml}/examples/viridun.haml (99%) rename src/{modules => xml}/filters.haml (99%) rename src/{modules => xml}/gamemode_blitz.haml (97%) rename src/{modules => xml}/gamemode_ctw.haml (98%) rename src/{modules => xml}/gamemode_dtc.haml (97%) rename src/{modules => xml}/gamemode_dtm.haml (97%) rename src/{modules => xml}/gamemode_other.haml (98%) rename src/{modules => xml}/gamemode_tdm.haml (97%) rename src/{modules => xml}/includes.haml (97%) rename src/{modules/main.haml => xml/index.haml} (98%) rename src/{modules.haml => xml/index2.haml} (97%) rename src/{modules => xml}/items.haml (99%) rename src/{modules => xml}/killreward.haml (96%) rename src/{modules => xml}/kits.haml (98%) rename src/{modules => xml}/lanes.haml (97%) rename src/{modules => xml}/mobs.haml (98%) rename src/{modules => xml}/other_settings.haml (98%) rename src/{modules => xml}/playable_region.haml (97%) rename src/{modules => xml}/portals.haml (99%) rename src/{modules => xml}/potions.haml (97%) rename src/{modules => xml}/projectiles.haml (98%) rename src/{ => xml}/reference/enchantments.haml (99%) rename src/{ => xml}/reference/formatting.haml (99%) rename src/{reference.haml => xml/reference/index.haml} (96%) rename src/{ => xml}/reference/inventory.haml (93%) rename src/{ => xml}/reference/potion_effects.haml (99%) rename src/{modules => xml}/regions.haml (99%) rename src/{modules => xml}/repair_remove.haml (98%) rename src/{modules => xml}/rules.haml (95%) rename src/{modules => xml}/score_boxes.haml (97%) rename src/{modules => xml}/spawns.haml (99%) rename src/{modules => xml}/teams.haml (97%) rename src/{modules => xml}/tnt.haml (96%) rename src/{modules => xml}/tutorial.haml (98%) diff --git a/src/_layouts/default.haml b/src/_layouts/default.haml index 5c6106d..40655ae 100644 --- a/src/_layouts/default.haml +++ b/src/_layouts/default.haml @@ -1,7 +1,7 @@ !!! 5 %html %head - %title PGM XML Documentation + %title PGM Documentation %meta{:"http-equiv" => "Content-Type", :content => "text/html;charset=utf-8"} %meta{:name => "viewport", :content => "width=device-width, initial-scale=1.0"} - @rand = SecureRandom.hex(13) @@ -21,7 +21,7 @@ .navbar-header %a.navbar-brand{:href => "/"} %img{:src => "https://oc.tc/assets/logo.png"} - PGM XML Documentation + PGM Documentation %button.navbar-toggle{:type => "button", :"data-toggle" => "collapse", :"data-target" => ".navbar-main-collapse"} %span.sr-only Toggle navigation %span.icon-bar @@ -29,22 +29,27 @@ %span.icon-bar %nav.collapse.navbar-collapse.navbar-main-collapse %ul.nav.navbar-nav.navbar-right - %li{:class => (current_page.include?("index") ? "active" : "")} + %li{:class => (current_page.include?("/src/index") ? "active" : "")} %a{:href => "/"} %i.glyphicon.glyphicon-home - Home - %li{:class => (current_page.include?("modules") ? "active" : "")} - %a{:href => "/modules/main"} - %i.glyphicon.glyphicon-th-large - Modules - %li{:class => (current_page.include?("reference") ? "active" : "")} - %a{:href => "/reference/inventory"} - %i.glyphicon.glyphicon-book - Reference - %li{:class => (current_page.include?("examples") ? "active" : "")} - %a{:href => "/examples"} + Overview + %li{:class => (current_page.include?("/src/xml") ? "active" : "")} + %a{:href => "/xml/"} %i.glyphicon.glyphicon-file - Examples + XML Docs + %li{:class => (current_page.include?("/src/api") ? "active" : "")} + %a{:href => "/api/"} + %i.glyphicon.glyphicon-globe + API Docs + - if current_page.include?("/xml/") + .container + %ul.nav.nav-tabs.subnav + = partial('xml_nav') + - elsif current_page.include?("/api/") + .container + %ul.nav.nav-tabs.subnav + = partial('api_nav') + = yield .container %hr diff --git a/src/_partials/api_nav.haml b/src/_partials/api_nav.haml new file mode 100644 index 0000000..050b713 --- /dev/null +++ b/src/_partials/api_nav.haml @@ -0,0 +1,8 @@ +%li.pull-right{:class => (current_page.include?("/src/api/reference") ? "active" : "")} + %a{:href => "/api/reference/"} + %i.glyphicon.glyphicon-book + Reference +%li.pull-right{:class => (current_page.match(/\/src\/api\/[^\/]*$/) != nil ? "active" : "")} + %a{:href => "/api/"} + %i.glyphicon.glyphicon-transfer + Usage \ No newline at end of file diff --git a/src/_partials/examples_sidebar.haml b/src/_partials/examples_sidebar.haml index fce284c..2b695f0 100644 --- a/src/_partials/examples_sidebar.haml +++ b/src/_partials/examples_sidebar.haml @@ -1,9 +1,9 @@ - @nav_title = "Map XML Examples" - @subnav_content = [\ -- {"path" => "examples/snowy_wars", "name" => "Snowy Wars"},\ -- {"path" => "examples/viridun", "name" => "Viridun"},\ -- {"path" => "examples/harb", "name" => "Harb"},\ -- {"path" => "examples/rfv3", "name" => "Race For Victory 3"},\ -- {"path" => "examples/eldritch", "name" => "GS: Eldritch"}] +- {"path" => "xml/examples/snowy_wars", "name" => "Snowy Wars"},\ +- {"path" => "xml/examples/viridun", "name" => "Viridun"},\ +- {"path" => "xml/examples/harb", "name" => "Harb"},\ +- {"path" => "xml/examples/rfv3", "name" => "Race For Victory 3"},\ +- {"path" => "xml/examples/eldritch", "name" => "GS: Eldritch"}] = partial('sidebar') diff --git a/src/_partials/modules_sidebar.haml b/src/_partials/modules_sidebar.haml index 7144fa7..151691d 100644 --- a/src/_partials/modules_sidebar.haml +++ b/src/_partials/modules_sidebar.haml @@ -1,36 +1,36 @@ - @nav_title = "XML Modules" - @subnav_content = [\ -- {"path" => "modules/main", "name" => "Main Map Element"},\ -- {"path" => "modules/includes", "name" => "XML File Includes"},\ -- {"path" => "modules/tutorial", "name" => "Map Tutorial"},\ +- {"path" => "xml/", "name" => "Main Map Element", "match" => /xml\/index\.[^\/]*$/},\ +- {"path" => "xml/includes", "name" => "XML File Includes"},\ +- {"path" => "xml/tutorial", "name" => "Map Tutorial"},\ - "Game Modes",\ -- {"path" => "modules/gamemode_ctw", "name" => "Capture the Wool"},\ -- {"path" => "modules/gamemode_dtm", "name" => "Destroy the Monument"},\ -- {"path" => "modules/gamemode_blitz", "name" => "Blitz"},\ -- {"path" => "modules/gamemode_dtc", "name" => "Destroy the Core"},\ -- {"path" => "modules/gamemode_tdm", "name" => "Team Death-match"},\ -- {"path" => "modules/gamemode_other", "name" => "Other Game Modes"},\ +- {"path" => "xml/gamemode_ctw", "name" => "Capture the Wool"},\ +- {"path" => "xml/gamemode_dtm", "name" => "Destroy the Monument"},\ +- {"path" => "xml/gamemode_blitz", "name" => "Blitz"},\ +- {"path" => "xml/gamemode_dtc", "name" => "Destroy the Core"},\ +- {"path" => "xml/gamemode_tdm", "name" => "Team Death-match"},\ +- {"path" => "xml/gamemode_other", "name" => "Other Game Modes"},\ - "Game Settings",\ -- {"path" => "modules/teams", "name" => "Teams"},\ -- {"path" => "modules/rules", "name" => "Rules"},\ -- {"path" => "modules/kits", "name" => "Kits"},\ -- {"path" => "modules/classes", "name" => "Classes"},\ -- {"path" => "modules/items", "name" => "Items & Armor"},\ -- {"path" => "modules/potions", "name" => "Potion Effects"},\ -- {"path" => "modules/repair_remove", "name" => "Repair & Remove"},\ -- {"path" => "modules/disabledamage", "name" => "Disable Damage"},\ -- {"path" => "modules/projectiles", "name" => "Projectiles"},\ -- {"path" => "modules/tnt", "name" => "TNT"},\ -- {"path" => "modules/mobs", "name" => "Mob Spawning"},\ -- {"path" => "modules/killreward", "name" => "Kill Reward"},\ -- {"path" => "modules/other_settings", "name" => "Other Settings"},\ +- {"path" => "xml/teams", "name" => "Teams"},\ +- {"path" => "xml/rules", "name" => "Rules"},\ +- {"path" => "xml/kits", "name" => "Kits"},\ +- {"path" => "xml/classes", "name" => "Classes"},\ +- {"path" => "xml/items", "name" => "Items & Armor"},\ +- {"path" => "xml/potions", "name" => "Potion Effects"},\ +- {"path" => "xml/repair_remove", "name" => "Repair & Remove"},\ +- {"path" => "xml/disabledamage", "name" => "Disable Damage"},\ +- {"path" => "xml/projectiles", "name" => "Projectiles"},\ +- {"path" => "xml/tnt", "name" => "TNT"},\ +- {"path" => "xml/mobs", "name" => "Mob Spawning"},\ +- {"path" => "xml/killreward", "name" => "Kill Reward"},\ +- {"path" => "xml/other_settings", "name" => "Other Settings"},\ - "Filters & Regions",\ -- {"path" => "modules/filters", "name" => "Filters"},\ -- {"path" => "modules/regions", "name" => "Regions"},\ -- {"path" => "modules/spawns", "name" => "Spawns"},\ -- {"path" => "modules/playable_region", "name" => "Playable Region"},\ -- {"path" => "modules/lanes", "name" => "Lanes"},\ -- {"path" => "modules/portals", "name" => "Portals"},\ -- {"path" => "modules/score_boxes", "name" => "Score Boxes"}] +- {"path" => "xml/filters", "name" => "Filters"},\ +- {"path" => "xml/regions", "name" => "Regions"},\ +- {"path" => "xml/spawns", "name" => "Spawns"},\ +- {"path" => "xml/playable_region", "name" => "Playable Region"},\ +- {"path" => "xml/lanes", "name" => "Lanes"},\ +- {"path" => "xml/portals", "name" => "Portals"},\ +- {"path" => "xml/score_boxes", "name" => "Score Boxes"}] = partial('sidebar') diff --git a/src/_partials/reference_sidebar.haml b/src/_partials/reference_sidebar.haml index 184007a..d4e1ec6 100644 --- a/src/_partials/reference_sidebar.haml +++ b/src/_partials/reference_sidebar.haml @@ -1,8 +1,8 @@ - @nav_title = "General Reference" - @subnav_content = [\ -- {"path" => "reference/inventory", "name" => "Inventory"},\ -- {"path" => "reference/formatting", "name" => "Formatting & Colors"},\ -- {"path" => "reference/enchantments", "name" => "Enchantments"},\ -- {"path" => "reference/potion_effects", "name" => "Potions"}] +- {"path" => "xml/reference/inventory", "name" => "Inventory"},\ +- {"path" => "xml/reference/formatting", "name" => "Formatting & Colors"},\ +- {"path" => "xml/reference/enchantments", "name" => "Enchantments"},\ +- {"path" => "xml/reference/potion_effects", "name" => "Potions"}] = partial('sidebar') diff --git a/src/_partials/sidebar.haml b/src/_partials/sidebar.haml index a92bdeb..f81da08 100644 --- a/src/_partials/sidebar.haml +++ b/src/_partials/sidebar.haml @@ -6,8 +6,12 @@ %ul.dropdown-menu.subnav-dropdown{:role => "menu", :"style" => "width: 100%;"} - @subnav_content.each do |item| - if item.kind_of?(Hash) - %li{:class => (current_page.include?("#{item['path']}") ? "active" : "")} - %a{:href => "/#{item['path']}"} #{item['name']} + - if item.has_key?('match') + %li{:class => (current_page.match(item['match']) ? "active" : "")} + %a{:href => "/#{item['path']}"} #{item['name']} + - else + %li{:class => (current_page.include?("#{item['path']}") ? "active" : "")} + %a{:href => "/#{item['path']}"} #{item['name']} - elsif item.kind_of?(String) %li.divider %li.dropdown-header #{item} @@ -17,8 +21,12 @@ %ul.nav.nav-pills.nav-stacked.docs-nav-pills - @subnav_content.each do |item| - if item.kind_of?(Hash) - %li{:class => (current_page.include?("#{item['path']}") ? "active" : "")} - %a{:href => "/#{item['path']}"} #{item['name']} + - if item.has_key?('match') + %li{:class => (current_page.match(item['match']) ? "active" : "")} + %a{:href => "/#{item['path']}"} #{item['name']} + - else + %li{:class => (current_page.include?("#{item['path']}") ? "active" : "")} + %a{:href => "/#{item['path']}"} #{item['name']} - elsif item.kind_of?(String) %li %h4 #{item} diff --git a/src/_partials/xml_nav.haml b/src/_partials/xml_nav.haml new file mode 100644 index 0000000..f97b425 --- /dev/null +++ b/src/_partials/xml_nav.haml @@ -0,0 +1,12 @@ +%li.pull-right{:class => (current_page.include?("/src/xml/examples") ? "active" : "")} + %a{:href => "/xml/examples/"} + %i.glyphicon.glyphicon-file + Examples +%li.pull-right{:class => (current_page.include?("/src/xml/reference") ? "active" : "")} + %a{:href => "/xml/reference/inventory"} + %i.glyphicon.glyphicon-book + Reference +%li.pull-right{:class => (current_page.match(/\/src\/xml\/[^\/]*$/) != nil ? "active" : "")} + %a{:href => "/xml/"} + %i.glyphicon.glyphicon-th-large + Modules \ No newline at end of file diff --git a/src/api/index.haml b/src/api/index.haml new file mode 100644 index 0000000..ace472b --- /dev/null +++ b/src/api/index.haml @@ -0,0 +1,8 @@ +.container + .jumbotron.jumbotron-mini + %h1 PGM API Documentation + %p.lead Proper API Usage + %section + .page-header + %h1 Welcome + %p Etiam porta sem malesuada magna mollis euismod. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. \ No newline at end of file diff --git a/src/api/reference/index.haml b/src/api/reference/index.haml new file mode 100644 index 0000000..f97ea9d --- /dev/null +++ b/src/api/reference/index.haml @@ -0,0 +1,8 @@ +.container + .jumbotron.jumbotron-mini + %h1 PGM API Documentation + %p.lead Reference + %section + .page-header + %h1 Risus Ornare + %p Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Vestibulum id ligula porta felis euismod semper. \ No newline at end of file diff --git a/src/css/style.css b/src/css/style.css index d19c537..c562b1d 100644 --- a/src/css/style.css +++ b/src/css/style.css @@ -9,7 +9,8 @@ body { float: left; } -.navbar a i.glyphicon { +.navbar a i.glyphicon, +.subnav a i.glyphicon { font-size: 12px; margin-bottom: 1px; } @@ -33,9 +34,29 @@ body { box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); } +@media (min-width: 768px) { + .jumbotron-mini { + padding: 20px 30px; + font-size: 50%; + padding-bottom: 14px; + } +} +@media (max-width: 767px) { + .jumbotron-mini { + padding: 24px 40px; + padding-bottom: 20px; + } +} +.jumbotron .lead { + margin-bottom: 10px; +} +.jumbotron h1 { + margin-top: 0; +} + /* Jumbotron pattern overlay ------------------------- */ -.jumbotron .container { +.jumbotron:content { position: relative; z-index: 2; } @@ -50,6 +71,7 @@ body { bottom: 0; left: 0; opacity: .8; + z-index: 0; } code { @@ -75,12 +97,20 @@ code { float: none !important; } +.subnav { + margin-bottom: 30px; +} + .docs-nav-pills > li > a { position: relative; display: block; padding: 8px 14px; } +.well h1 { + margin-top: 0; +} + .dropdown-menu > .active > a{ color: #333333; background-color: #e6e6e6; diff --git a/src/index.haml b/src/index.haml index 04b77d3..578a925 100644 --- a/src/index.haml +++ b/src/index.haml @@ -1,8 +1,22 @@ .container - .jumbotron.subhead - %h1 PGM XML Documentation - %p.lead Documentation on XML files that are required for each map added to the servers %section .page-header %h1 Welcome - %p These docs provide valuable information to be used when coding XML files. XML files are needed in order for any map released on the Overcast Network to function. The XML defines aspects of the game such as spawn points, kits and more. + %p Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Sed posuere consectetur est at lobortis. + .row + .col-md-6.text-center + .well + %h1 + %i.glyphicon.glyphicon-file + %h4 XML Documentation + %p Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. + %a.btn.btn-primary.btn-lg{:href => "/xml/"} Browse the XML docs + + + .col-md-6.text-center + .well + %h1 + %i.glyphicon.glyphicon-globe + %h4 Web API Documentation + %p Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec id elit non mi porta gravida at eget metus. Nulla vitae elit libero, a pharetra augue. + %a.btn.btn-primary.btn-lg{:href => "/api/"} Browse the API docs diff --git a/src/modules/classes.haml b/src/xml/classes.haml similarity index 99% rename from src/modules/classes.haml rename to src/xml/classes.haml index 455ab86..f48d018 100644 --- a/src/modules/classes.haml +++ b/src/xml/classes.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/disabledamage.haml b/src/xml/disabledamage.haml similarity index 99% rename from src/modules/disabledamage.haml rename to src/xml/disabledamage.haml index c97e454..231d62b 100644 --- a/src/modules/disabledamage.haml +++ b/src/xml/disabledamage.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/examples/eldritch.haml b/src/xml/examples/eldritch.haml similarity index 99% rename from src/examples/eldritch.haml rename to src/xml/examples/eldritch.haml index e034e64..af0aa52 100644 --- a/src/examples/eldritch.haml +++ b/src/xml/examples/eldritch.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/examples/harb.haml b/src/xml/examples/harb.haml similarity index 99% rename from src/examples/harb.haml rename to src/xml/examples/harb.haml index 1643d5f..a9c68b2 100644 --- a/src/examples/harb.haml +++ b/src/xml/examples/harb.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/examples.haml b/src/xml/examples/index.haml similarity index 94% rename from src/examples.haml rename to src/xml/examples/index.haml index b95e6d5..600aa5f 100644 --- a/src/examples.haml +++ b/src/xml/examples/index.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/examples/rfv3.haml b/src/xml/examples/rfv3.haml similarity index 99% rename from src/examples/rfv3.haml rename to src/xml/examples/rfv3.haml index 15ae13d..8e7d03b 100644 --- a/src/examples/rfv3.haml +++ b/src/xml/examples/rfv3.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/examples/snowy_wars.haml b/src/xml/examples/snowy_wars.haml similarity index 99% rename from src/examples/snowy_wars.haml rename to src/xml/examples/snowy_wars.haml index 2cda012..fb86b29 100644 --- a/src/examples/snowy_wars.haml +++ b/src/xml/examples/snowy_wars.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/examples/viridun.haml b/src/xml/examples/viridun.haml similarity index 99% rename from src/examples/viridun.haml rename to src/xml/examples/viridun.haml index 617e860..6834437 100644 --- a/src/examples/viridun.haml +++ b/src/xml/examples/viridun.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Examples %p.lead XML File Examples %section diff --git a/src/modules/filters.haml b/src/xml/filters.haml similarity index 99% rename from src/modules/filters.haml rename to src/xml/filters.haml index ec47f99..9df2d39 100644 --- a/src/modules/filters.haml +++ b/src/xml/filters.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/gamemode_blitz.haml b/src/xml/gamemode_blitz.haml similarity index 97% rename from src/modules/gamemode_blitz.haml rename to src/xml/gamemode_blitz.haml index 7513a4a..5e1e7ee 100644 --- a/src/modules/gamemode_blitz.haml +++ b/src/xml/gamemode_blitz.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/gamemode_ctw.haml b/src/xml/gamemode_ctw.haml similarity index 98% rename from src/modules/gamemode_ctw.haml rename to src/xml/gamemode_ctw.haml index 528f85d..5c08d7a 100644 --- a/src/modules/gamemode_ctw.haml +++ b/src/xml/gamemode_ctw.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/gamemode_dtc.haml b/src/xml/gamemode_dtc.haml similarity index 97% rename from src/modules/gamemode_dtc.haml rename to src/xml/gamemode_dtc.haml index 6bb33e6..fa8f1ce 100644 --- a/src/modules/gamemode_dtc.haml +++ b/src/xml/gamemode_dtc.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/gamemode_dtm.haml b/src/xml/gamemode_dtm.haml similarity index 97% rename from src/modules/gamemode_dtm.haml rename to src/xml/gamemode_dtm.haml index b9a6166..908dc38 100644 --- a/src/modules/gamemode_dtm.haml +++ b/src/xml/gamemode_dtm.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/gamemode_other.haml b/src/xml/gamemode_other.haml similarity index 98% rename from src/modules/gamemode_other.haml rename to src/xml/gamemode_other.haml index 7760791..bbb6f6a 100644 --- a/src/modules/gamemode_other.haml +++ b/src/xml/gamemode_other.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/gamemode_tdm.haml b/src/xml/gamemode_tdm.haml similarity index 97% rename from src/modules/gamemode_tdm.haml rename to src/xml/gamemode_tdm.haml index aa9fa7e..512bb7b 100644 --- a/src/modules/gamemode_tdm.haml +++ b/src/xml/gamemode_tdm.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Modes %section diff --git a/src/modules/includes.haml b/src/xml/includes.haml similarity index 97% rename from src/modules/includes.haml rename to src/xml/includes.haml index 9237925..355296f 100644 --- a/src/modules/includes.haml +++ b/src/xml/includes.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead XML Helpers %section diff --git a/src/modules/main.haml b/src/xml/index.haml similarity index 98% rename from src/modules/main.haml rename to src/xml/index.haml index 739bfd2..b4b6dbe 100644 --- a/src/modules/main.haml +++ b/src/xml/index.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Main Map Element %section diff --git a/src/modules.haml b/src/xml/index2.haml similarity index 97% rename from src/modules.haml rename to src/xml/index2.haml index 4bdae99..385c157 100644 --- a/src/modules.haml +++ b/src/xml/index2.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Building blocks for the map XML. %section diff --git a/src/modules/items.haml b/src/xml/items.haml similarity index 99% rename from src/modules/items.haml rename to src/xml/items.haml index 2a76ab4..be88578 100644 --- a/src/modules/items.haml +++ b/src/xml/items.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/killreward.haml b/src/xml/killreward.haml similarity index 96% rename from src/modules/killreward.haml rename to src/xml/killreward.haml index 97d719d..d3ec557 100644 --- a/src/modules/killreward.haml +++ b/src/xml/killreward.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/kits.haml b/src/xml/kits.haml similarity index 98% rename from src/modules/kits.haml rename to src/xml/kits.haml index a420dc6..094006f 100644 --- a/src/modules/kits.haml +++ b/src/xml/kits.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/lanes.haml b/src/xml/lanes.haml similarity index 97% rename from src/modules/lanes.haml rename to src/xml/lanes.haml index 7e76a98..144c0e0 100644 --- a/src/modules/lanes.haml +++ b/src/xml/lanes.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/mobs.haml b/src/xml/mobs.haml similarity index 98% rename from src/modules/mobs.haml rename to src/xml/mobs.haml index fa68ee4..9ce9a5f 100644 --- a/src/modules/mobs.haml +++ b/src/xml/mobs.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/other_settings.haml b/src/xml/other_settings.haml similarity index 98% rename from src/modules/other_settings.haml rename to src/xml/other_settings.haml index a0df44d..0a064d6 100644 --- a/src/modules/other_settings.haml +++ b/src/xml/other_settings.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/playable_region.haml b/src/xml/playable_region.haml similarity index 97% rename from src/modules/playable_region.haml rename to src/xml/playable_region.haml index 2eced81..f0b5a53 100644 --- a/src/modules/playable_region.haml +++ b/src/xml/playable_region.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/portals.haml b/src/xml/portals.haml similarity index 99% rename from src/modules/portals.haml rename to src/xml/portals.haml index d3f1503..48cadf0 100644 --- a/src/modules/portals.haml +++ b/src/xml/portals.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/potions.haml b/src/xml/potions.haml similarity index 97% rename from src/modules/potions.haml rename to src/xml/potions.haml index fa8a0f0..5b5fb5e 100644 --- a/src/modules/potions.haml +++ b/src/xml/potions.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/projectiles.haml b/src/xml/projectiles.haml similarity index 98% rename from src/modules/projectiles.haml rename to src/xml/projectiles.haml index 0937873..328f74e 100644 --- a/src/modules/projectiles.haml +++ b/src/xml/projectiles.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/reference/enchantments.haml b/src/xml/reference/enchantments.haml similarity index 99% rename from src/reference/enchantments.haml rename to src/xml/reference/enchantments.haml index c50415a..db53cc4 100644 --- a/src/reference/enchantments.haml +++ b/src/xml/reference/enchantments.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Reference /%p.lead Main map element %section diff --git a/src/reference/formatting.haml b/src/xml/reference/formatting.haml similarity index 99% rename from src/reference/formatting.haml rename to src/xml/reference/formatting.haml index e4599f3..90323d9 100644 --- a/src/reference/formatting.haml +++ b/src/xml/reference/formatting.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Reference /%p.lead Main map element %section diff --git a/src/reference.haml b/src/xml/reference/index.haml similarity index 96% rename from src/reference.haml rename to src/xml/reference/index.haml index 6c4ae87..7ffe9c3 100644 --- a/src/reference.haml +++ b/src/xml/reference/index.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Reference %section .row diff --git a/src/reference/inventory.haml b/src/xml/reference/inventory.haml similarity index 93% rename from src/reference/inventory.haml rename to src/xml/reference/inventory.haml index f9b52b4..c27a1fd 100644 --- a/src/reference/inventory.haml +++ b/src/xml/reference/inventory.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Reference /%p.lead Main map element %section diff --git a/src/reference/potion_effects.haml b/src/xml/reference/potion_effects.haml similarity index 99% rename from src/reference/potion_effects.haml rename to src/xml/reference/potion_effects.haml index 752c05f..4d677b1 100644 --- a/src/reference/potion_effects.haml +++ b/src/xml/reference/potion_effects.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Reference /%p.lead Main map element %section diff --git a/src/modules/regions.haml b/src/xml/regions.haml similarity index 99% rename from src/modules/regions.haml rename to src/xml/regions.haml index c2cef3a..112dc93 100644 --- a/src/modules/regions.haml +++ b/src/xml/regions.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/repair_remove.haml b/src/xml/repair_remove.haml similarity index 98% rename from src/modules/repair_remove.haml rename to src/xml/repair_remove.haml index e41b9ed..57e99f7 100644 --- a/src/modules/repair_remove.haml +++ b/src/xml/repair_remove.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/rules.haml b/src/xml/rules.haml similarity index 95% rename from src/modules/rules.haml rename to src/xml/rules.haml index dc0d6c9..ddc7796 100644 --- a/src/modules/rules.haml +++ b/src/xml/rules.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/score_boxes.haml b/src/xml/score_boxes.haml similarity index 97% rename from src/modules/score_boxes.haml rename to src/xml/score_boxes.haml index 44ffdec..4cfff25 100644 --- a/src/modules/score_boxes.haml +++ b/src/xml/score_boxes.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/spawns.haml b/src/xml/spawns.haml similarity index 99% rename from src/modules/spawns.haml rename to src/xml/spawns.haml index 490dcb9..1b0e3c2 100644 --- a/src/modules/spawns.haml +++ b/src/xml/spawns.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Filters & Regions %section diff --git a/src/modules/teams.haml b/src/xml/teams.haml similarity index 97% rename from src/modules/teams.haml rename to src/xml/teams.haml index 892c2b3..706710b 100644 --- a/src/modules/teams.haml +++ b/src/xml/teams.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/tnt.haml b/src/xml/tnt.haml similarity index 96% rename from src/modules/tnt.haml rename to src/xml/tnt.haml index 9358cbf..a607532 100644 --- a/src/modules/tnt.haml +++ b/src/xml/tnt.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead Game Settings %section diff --git a/src/modules/tutorial.haml b/src/xml/tutorial.haml similarity index 98% rename from src/modules/tutorial.haml rename to src/xml/tutorial.haml index 622a231..ba97e8c 100644 --- a/src/modules/tutorial.haml +++ b/src/xml/tutorial.haml @@ -1,5 +1,5 @@ .container - .jumbotron.subhead + .jumbotron.jumbotron-mini %h1 Modules %p.lead General %section From f2e7c54fc0fd87ea5310cac2f0368c3cb744ce06 Mon Sep 17 00:00:00 2001 From: McSpider Date: Sat, 16 Nov 2013 22:36:04 -0800 Subject: [PATCH 2/7] Tweak jumbotron-mini sizes/padding. --- src/css/style.css | 53 ++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 26 deletions(-) diff --git a/src/css/style.css b/src/css/style.css index c562b1d..282b69a 100644 --- a/src/css/style.css +++ b/src/css/style.css @@ -25,7 +25,7 @@ body { background-color: #e7e7e7; } -.jumbotron { +.jumbotron-mini { position: relative; color: #fff; background: #450f43; @@ -34,34 +34,10 @@ body { box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); } -@media (min-width: 768px) { - .jumbotron-mini { - padding: 20px 30px; - font-size: 50%; - padding-bottom: 14px; - } -} -@media (max-width: 767px) { - .jumbotron-mini { - padding: 24px 40px; - padding-bottom: 20px; - } -} -.jumbotron .lead { - margin-bottom: 10px; -} -.jumbotron h1 { - margin-top: 0; -} - /* Jumbotron pattern overlay ------------------------- */ -.jumbotron:content { - position: relative; - z-index: 2; -} -.jumbotron:after { +.jumbotron-mini:after { background: url("../img/grid-15px.png") repeat scroll center center transparent; content: ''; display: block; @@ -74,6 +50,31 @@ body { z-index: 0; } +@media (min-width: 768px) { + .jumbotron-mini { + padding: 30px 30px; + padding-bottom: 20px; + } + .jumbotron-mini h1 { + font-size: 45px; + } + .jumbotron-mini .lead { + font-size: 20px; + } +} +@media (max-width: 767px) { + .jumbotron-mini { + padding: 24px 40px; + padding-bottom: 14px; + } +} +.jumbotron-mini .lead { + margin-bottom: 10px; +} +.jumbotron-mini h1 { + margin-top: 0; +} + code { padding: 1px 4px; } From 3dd81f8f47a1ab906feb53ee7992ae5bddba0bec Mon Sep 17 00:00:00 2001 From: mrapple Date: Sun, 17 Nov 2013 01:28:14 -0600 Subject: [PATCH 3/7] New lines! --- src/_partials/xml_nav.haml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/_partials/xml_nav.haml b/src/_partials/xml_nav.haml index f97b425..aaea462 100644 --- a/src/_partials/xml_nav.haml +++ b/src/_partials/xml_nav.haml @@ -9,4 +9,4 @@ %li.pull-right{:class => (current_page.match(/\/src\/xml\/[^\/]*$/) != nil ? "active" : "")} %a{:href => "/xml/"} %i.glyphicon.glyphicon-th-large - Modules \ No newline at end of file + Modules From 66fc6150e4e87ee575242bdc46200d1a2e629a82 Mon Sep 17 00:00:00 2001 From: mrapple Date: Sun, 17 Nov 2013 01:33:35 -0600 Subject: [PATCH 4/7] Update title --- src/_layouts/default.haml | 4 ++-- src/css/style.css | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/_layouts/default.haml b/src/_layouts/default.haml index 40655ae..3244a04 100644 --- a/src/_layouts/default.haml +++ b/src/_layouts/default.haml @@ -1,7 +1,7 @@ !!! 5 %html %head - %title PGM Documentation + %title Overcast Network Documentation %meta{:"http-equiv" => "Content-Type", :content => "text/html;charset=utf-8"} %meta{:name => "viewport", :content => "width=device-width, initial-scale=1.0"} - @rand = SecureRandom.hex(13) @@ -21,7 +21,7 @@ .navbar-header %a.navbar-brand{:href => "/"} %img{:src => "https://oc.tc/assets/logo.png"} - PGM Documentation + Overcast Network Documentation %button.navbar-toggle{:type => "button", :"data-toggle" => "collapse", :"data-target" => ".navbar-main-collapse"} %span.sr-only Toggle navigation %span.icon-bar diff --git a/src/css/style.css b/src/css/style.css index 282b69a..2dca8a5 100644 --- a/src/css/style.css +++ b/src/css/style.css @@ -7,6 +7,7 @@ body { margin-right: 8px; margin-bottom: -11px; float: left; + width: 32px; } .navbar a i.glyphicon, From 46ffc075c2aa7c77427c0eb9e019d5ad72602ac2 Mon Sep 17 00:00:00 2001 From: McSpider Date: Mon, 18 Nov 2013 12:07:21 -0800 Subject: [PATCH 5/7] Adjust sidebar to better match forum sidebar. --- src/css/style.css | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/src/css/style.css b/src/css/style.css index 2dca8a5..45e979b 100644 --- a/src/css/style.css +++ b/src/css/style.css @@ -31,7 +31,7 @@ body { color: #fff; background: #450f43; -webkit-box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); - -moz-box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); + -moz-box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); box-shadow: inset 0 3px 7px rgba(0,0,0,.2), inset 0 -3px 7px rgba(0,0,0,.2); } @@ -77,7 +77,7 @@ body { } code { - padding: 1px 4px; + padding: 1px 4px; } .right-ref-link { @@ -106,7 +106,12 @@ code { .docs-nav-pills > li > a { position: relative; display: block; - padding: 8px 14px; + padding: 3px 15px +} + +.docs-nav-pills h4 { + padding-bottom: 5px; + border-bottom: 1px solid #ddd; } .well h1 { From c516ab9ff0c0b79f3ce147a5939e886aef35a691 Mon Sep 17 00:00:00 2001 From: McSpider Date: Mon, 18 Nov 2013 12:09:28 -0800 Subject: [PATCH 6/7] Replace lorem ipsum text with less placeholderish text. --- src/index.haml | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/src/index.haml b/src/index.haml index 578a925..46dff87 100644 --- a/src/index.haml +++ b/src/index.haml @@ -2,14 +2,16 @@ %section .page-header %h1 Welcome - %p Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Sed posuere consectetur est at lobortis. + %p + The docs pertaining to XML files and the web API can be found here. + %br This information is useful to people who wish to create XML files for maps; or Overcast Network related minecraft mods, applications, etc. .row .col-md-6.text-center .well %h1 %i.glyphicon.glyphicon-file %h4 XML Documentation - %p Donec id elit non mi porta gravida at eget metus. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. + %p These docs provide valuable information for coding XML files. XML files are needed in order for any map released on the Overcast Network to function. The XML defines aspects of the game such as spawn points, kits and more. %a.btn.btn-primary.btn-lg{:href => "/xml/"} Browse the XML docs @@ -18,5 +20,10 @@ %h1 %i.glyphicon.glyphicon-globe %h4 Web API Documentation - %p Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Donec id elit non mi porta gravida at eget metus. Nulla vitae elit libero, a pharetra augue. + %p Here you can find out how to access data relating to Overcast Network and its users. This API can be used to query a users score, the maps currently being played, and more. %a.btn.btn-primary.btn-lg{:href => "/api/"} Browse the API docs + + %p.text-muted + This documentation is open source and can be found on + %a{:href => "https://github.com/OvercastNetwork/docs.oc.tc/"} github. + If you see any errors or lack of information feel free to make a pull request or issue. From 178bf6fdc564366d5017e5f9bc4e4d2cb06d42c8 Mon Sep 17 00:00:00 2001 From: mrapple Date: Mon, 18 Nov 2013 17:11:25 -0600 Subject: [PATCH 7/7] Tidy things up a bit --- src/api/index.haml | 15 +++++++++----- src/api/reference/index.haml | 13 ++++++++---- src/css/style.css | 1 - src/index.haml | 39 ++++++++++++++++++++++++++++-------- 4 files changed, 50 insertions(+), 18 deletions(-) diff --git a/src/api/index.haml b/src/api/index.haml index ace472b..ad47625 100644 --- a/src/api/index.haml +++ b/src/api/index.haml @@ -1,8 +1,13 @@ .container .jumbotron.jumbotron-mini - %h1 PGM API Documentation - %p.lead Proper API Usage + %h1 Web API Documentation + %p.lead Usage %section - .page-header - %h1 Welcome - %p Etiam porta sem malesuada magna mollis euismod. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. \ No newline at end of file + .alert.alert-danger + %strong Heads up! + The Web API is currently in + %i BETA + and this information is subject to change without notice. + .alert.alert-info + %strong No documentation yet. + As the Web API takes more shape these pages will fill up. diff --git a/src/api/reference/index.haml b/src/api/reference/index.haml index f97ea9d..6503102 100644 --- a/src/api/reference/index.haml +++ b/src/api/reference/index.haml @@ -1,8 +1,13 @@ .container .jumbotron.jumbotron-mini - %h1 PGM API Documentation + %h1 Web API Documentation %p.lead Reference %section - .page-header - %h1 Risus Ornare - %p Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Vestibulum id ligula porta felis euismod semper. \ No newline at end of file + .alert.alert-danger + %strong Heads up! + The Web API is currently in + %i BETA + and this information is subject to change without notice. + .alert.alert-info + %strong No documentation yet. + As the Web API takes more shape these pages will fill up. diff --git a/src/css/style.css b/src/css/style.css index 45e979b..e64d7b8 100644 --- a/src/css/style.css +++ b/src/css/style.css @@ -7,7 +7,6 @@ body { margin-right: 8px; margin-bottom: -11px; float: left; - width: 32px; } .navbar a i.glyphicon, diff --git a/src/index.haml b/src/index.haml index 46dff87..ba9bea7 100644 --- a/src/index.haml +++ b/src/index.haml @@ -3,27 +3,50 @@ .page-header %h1 Welcome %p - The docs pertaining to XML files and the web API can be found here. - %br This information is useful to people who wish to create XML files for maps; or Overcast Network related minecraft mods, applications, etc. + Documentation pertaining to XML files and the web API can be found here. + %p + This information is useful to people who wish to create XML files for maps; or Overcast Network related minecraft mods, applications, etc. + %br .row .col-md-6.text-center .well - %h1 + %h1 %i.glyphicon.glyphicon-file %h4 XML Documentation - %p These docs provide valuable information for coding XML files. XML files are needed in order for any map released on the Overcast Network to function. The XML defines aspects of the game such as spawn points, kits and more. + %p + These docs provide valuable information for coding + %br + XML files. XML files are needed in order for any map + %br + released on the Overcast Network to function. The XML + %br + defines aspects of the game such as spawn points, kits and more. %a.btn.btn-primary.btn-lg{:href => "/xml/"} Browse the XML docs .col-md-6.text-center .well - %h1 + %h1 %i.glyphicon.glyphicon-globe %h4 Web API Documentation - %p Here you can find out how to access data relating to Overcast Network and its users. This API can be used to query a users score, the maps currently being played, and more. + %p + Here you can find out how to access data relating to the + %br + Overcast Network and its users. This API can be used to + %br + query a users score, maps currently being played, and more. + %br + %b Note: + The Web API is incomplete and in + %i BETA. %a.btn.btn-primary.btn-lg{:href => "/api/"} Browse the API docs %p.text-muted This documentation is open source and can be found on - %a{:href => "https://github.com/OvercastNetwork/docs.oc.tc/"} github. - If you see any errors or lack of information feel free to make a pull request or issue. + = succeed '.' do + %a{:href => "https://github.com/OvercastNetwork/docs.oc.tc/", :target => :blank} GitHub + If you see any errors or lack of information, feel free to + %a{:href => "https://github.com/OvercastNetwork/docs.oc.tc/issues/new", :target => :blank} report an issue + or + = succeed '.' do + %a{:href => "https://github.com/OvercastNetwork/docs.oc.tc/fork", :target => :blank} make a pull request