Skip to content

Commit

Permalink
#56 improve documentation format
Browse files Browse the repository at this point in the history
  • Loading branch information
martindsouza committed Mar 7, 2015
1 parent 9b58700 commit 3e24049
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 0 deletions.
67 changes: 67 additions & 0 deletions docs/api.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!doctype html>
<!--
Instructions:
- Save this file.
- Replace "oraopensource" with your GitHub username.
- Replace "logger" with your GitHub repo name.
- Replace "Logger" with your project name.
- Upload this file (or commit to GitHub Pages).
Customize as you see fit!
-->
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width">

<title>Logger</title>

<!-- Flatdoc -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/legacy.js'></script>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/flatdoc.js'></script>

<!-- Flatdoc theme -->
<link href='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/style.css' rel='stylesheet'>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/script.js'></script>

<!-- Meta -->
<meta content="Logger" property="og:title">
<meta content="Logger description goes here." name="description">

<!-- Initializer -->
<script>
Flatdoc.run({
fetcher: Flatdoc.github('oraopensource/logger', 'docs/Logger API.md')
});
</script>
</head>
<body role='flatdoc'>

<div class='header'>
<div class='left'>
<h1>Logger</h1>
<ul>
<li><a href='https://github.com/oraopensource/logger'>View on GitHub</a></li>
<li><a href='https://github.com/oraopensource/logger/issues'>Issues</a></li>
</ul>
</div>
<div class='right'>
<!-- GitHub buttons: see http://ghbtns.com -->
<iframe src="http://ghbtns.com/github-btn.html?user=oraopensource&amp;repo=logger&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
</div>
</div>

<div class='content-root'>
<div class='menubar'>
<div class='menu section' role='flatdoc-menu'></div>
</div>
<div role='flatdoc-content' class='content'></div>
</div>

</body>
</html>
67 changes: 67 additions & 0 deletions docs/template.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!doctype html>
<!--
Instructions:
- Save this file.
- Replace "oraopensource" with your GitHub username.
- Replace "logger" with your GitHub repo name.
- Replace "Logger" with your project name.
- Upload this file (or commit to GitHub Pages).
Customize as you see fit!
-->
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width">

<title>Logger</title>

<!-- Flatdoc -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/legacy.js'></script>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/flatdoc.js'></script>

<!-- Flatdoc theme -->
<link href='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/style.css' rel='stylesheet'>
<script src='https://cdn.rawgit.com/rstacruz/flatdoc/v0.9.0/theme-white/script.js'></script>

<!-- Meta -->
<meta content="Logger" property="og:title">
<meta content="Logger description goes here." name="description">

<!-- Initializer -->
<script>
Flatdoc.run({
fetcher: Flatdoc.github('oraopensource/logger')
});
</script>
</head>
<body role='flatdoc'>

<div class='header'>
<div class='left'>
<h1>Logger</h1>
<ul>
<li><a href='https://github.com/oraopensource/logger'>View on GitHub</a></li>
<li><a href='https://github.com/oraopensource/logger/issues'>Issues</a></li>
</ul>
</div>
<div class='right'>
<!-- GitHub buttons: see http://ghbtns.com -->
<iframe src="http://ghbtns.com/github-btn.html?user=oraopensource&amp;repo=logger&amp;type=watch&amp;count=true" allowtransparency="true" frameborder="0" scrolling="0" width="110" height="20"></iframe>
</div>
</div>

<div class='content-root'>
<div class='menubar'>
<div class='menu section' role='flatdoc-menu'></div>
</div>
<div role='flatdoc-content' class='content'></div>
</div>

</body>
</html>

0 comments on commit 3e24049

Please sign in to comment.