Skip to content
This repository has been archived by the owner on Aug 20, 2021. It is now read-only.

Commit

Permalink
add initial docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Weiss committed Dec 27, 2018
1 parent 148f10b commit a02bb1f
Show file tree
Hide file tree
Showing 57 changed files with 6,314 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@
*.out

dist/

docs/public/
7 changes: 7 additions & 0 deletions docs/archetypes/blog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
+++
title = ""
description = ""
date = {{ .Date }}
weight = 20
draft = false
+++
6 changes: 6 additions & 0 deletions docs/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

9 changes: 9 additions & 0 deletions docs/archetypes/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
+++
title = ""
description = ""
date = {{ .Date }}
weight = 20
draft = false
bref = ""
toc = true
+++
25 changes: 25 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
baseURL = "https://opencontrol.github.io/oscalkit/"
languageCode = "en-us"
title = "oscalkit"
theme = "oscalkit"
description = "oscalkit is a CLI and Go SDK for OSCAL"
Paginate = 4
[Params]
RSSLink = "/index.xml"
author = "oscalkit" # add your company name
github = "oscalkit" # add your github profile name
twitter = "" # add your twitter profile
email = ""

[[menu.main]]
name = "Docs"
weight = -100
url = "/docs/"
# [[menu.main]]
# name = "Blog"
# weight = -100
# url = "/blog/"
# [[menu.main]]
# name = "Faq"
# weight = -100
# url = "/faq/"
6 changes: 6 additions & 0 deletions docs/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
+++
description = "oscalkit is a CLI tool and Go SDK for NIST's Open Security Controls Assessment Lanugage (OSCAL)"
title = "oscalkit"
draft = false

+++
20 changes: 20 additions & 0 deletions docs/content/account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
+++
title = "Sign In"
+++
<form action="" data-component="validate" method="post" class="form form-centered"><input type="hidden" name="authorize-token" value="">

<div class="form-item">
<label>Email <span id="user-email-validation-error"></span></label>
<input type="email" name="user-email" autofocus="true" autocomplete="off" style="background-image: url(&quot;data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAASCAYAAABSO15qAAAAAXNSR0IArs4c6QAAAPhJREFUOBHlU70KgzAQPlMhEvoQTg6OPoOjT+JWOnRqkUKHgqWP4OQbOPokTk6OTkVULNSLVc62oJmbIdzd95NcuGjX2/3YVI/Ts+t0WLE2ut5xsQ0O+90F6UxFjAI8qNcEGONia08e6MNONYwCS7EQAizLmtGUDEzTBNd1fxsYhjEBnHPQNG3KKTYV34F8ec/zwHEciOMYyrIE3/ehKAqIoggo9inGXKmFXwbyBkmSQJqmUNe15IRhCG3byphitm1/eUzDM4qR0TTNjEixGdAnSi3keS5vSk2UDKqqgizLqB4YzvassiKhGtZ/jDMtLOnHz7TE+yf8BaDZXA509yeBAAAAAElFTkSuQmCC&quot;); background-repeat: no-repeat; background-attachment: scroll; background-size: 16px 18px; background-position: 98% 50%; cursor: auto;">
</div>

<div class="form-item">
<label>Password <span id="user-password-validation-error"></span></label>
<input type="password" name="user-password" autocomplete="off" style="background-image: url(&quot;data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAASCAYAAABSO15qAAAAAXNSR0IArs4c6QAAAPhJREFUOBHlU70KgzAQPlMhEvoQTg6OPoOjT+JWOnRqkUKHgqWP4OQbOPokTk6OTkVULNSLVc62oJmbIdzd95NcuGjX2/3YVI/Ts+t0WLE2ut5xsQ0O+90F6UxFjAI8qNcEGONia08e6MNONYwCS7EQAizLmtGUDEzTBNd1fxsYhjEBnHPQNG3KKTYV34F8ec/zwHEciOMYyrIE3/ehKAqIoggo9inGXKmFXwbyBkmSQJqmUNe15IRhCG3byphitm1/eUzDM4qR0TTNjEixGdAnSi3keS5vSk2UDKqqgizLqB4YzvassiKhGtZ/jDMtLOnHz7TE+yf8BaDZXA509yeBAAAAAElFTkSuQmCC&quot;); background-repeat: no-repeat; background-attachment: scroll; background-size: 16px 18px; background-position: 98% 50%; cursor: auto;">
</div>

<p><button class="button primary width-100">Log in</button></p>
<p><a href="/password-recovery/" class="small muted">Forgot password?</a></p>
<p class="small">If you have any questions about authorization or you're our customer but haven't receive your login credentials, just send us a short email at <b>[email protected]</b> and we'll fix it right away.</p>

</form>
207 changes: 207 additions & 0 deletions docs/content/blog/collapse.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions docs/content/blog/inline-style.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
+++
date = "2017-04-02T21:56:55+01:00"
title = "Inline 🐣Text Styles"
tags = ["markdown","example"]
categories = ["general"]
draft = false
description = "This article is just a demo."
+++

Chocolate tiramisu pastry a link cotton candy sesame snaps. Dessert cake chocolate bar a bold part sugar plum bonbon marshmallow lollipop toffee soufflé. Donut caramels chocolate bar. Oat cake cookie a marked part cheesecake donut. Jelly-o <some> $code marzipan cake. Bonbon sesame snaps chocolate an italic part oat cake pudding sweet roll caramels bonbon. Soufflé muffin 👻 gummies sugar plum dessert bonbon bear claw. Sweet ice cream jujubes. Marzipan sugar plum pastry chocolate ⌘+A bar fruitcake. Lollipop lollipop brownie.
158 changes: 158 additions & 0 deletions docs/content/blog/messages.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
+++
date = "2017-04-10T16:41:34+01:00"
draft = false
weight = 90
description = "Versatile and refined messages, ideal for daily use"
title = "Messages"
bref = "Messages are an essential part of modern web and messages in Kube look nice"
+++

<h3 class="section-head" id="h-usage"><a href="#h-usage">Usage</a></h3>
<div class="example">
<div class="message open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="#install">Install</a> <span class="close small"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<div class="example">
<div class="message error open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message error"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<div class="example">
<div class="message success open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message success"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<div class="example">
<div class="message warning open" data-component="message" data-loaded="true">
<h5>Warning!</h5>You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small"></span>
</div>
<pre class="code skip"><span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"message warning"</span> <span class="hljs-attr">data-component</span>=<span class="hljs-string">"message"</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">h5</span>&gt;</span>...<span class="hljs-tag">&lt;/<span class="hljs-name">h5</span>&gt;</span>
...
<span class="hljs-tag">&lt;<span class="hljs-name">span</span> <span class="hljs-attr">class</span>=<span class="hljs-string">"close small"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
</pre>
</div>
<div class="example">
<div class="message focus open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message focus"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<div class="example">
<div class="message black open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small white"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message black"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<div class="example">
<div class="message inverted open" data-component="message" data-loaded="true">
You have 2 modules waiting to installation. <a href="">Install</a> <span class="close small"></span>
</div>
<pre class="code">&lt;div <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"message inverted"</span> data-component=<span class="hljs-string">"message"</span>&gt; ... &lt;span <span class="hljs-class"><span class="hljs-keyword">class</span></span>=<span class="hljs-string">"close small"</span>&gt;<span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">span</span>&gt;</span></span><span class="xml"><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span></span></pre>
</div>
<h3 class="section-head" id="h-options"><a href="#h-options">Options</a></h3>
<table>
<thead>
<tr>
<th class="w30">Name</th>
<th class="w30">Type</th>
<th class="w40">Default</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>closeSelector</code></td>
<td><var>string</var></td>
<td>.close</td>
</tr>
<tr>
<td><code>closeEvent</code></td>
<td><var>string</var></td>
<td>click</td>
</tr>
<tr>
<td><code>animationOpen</code></td>
<td><var>string</var></td>
<td>fadeIn</td>
</tr>
<tr>
<td><code>animationClose</code></td>
<td><var>string</var></td>
<td>fadeOut</td>
</tr>
</tbody>
</table>
<h4>Set an option</h4>
<p>Via data attribute:</p>
<pre class="code skip">&lt;<span class="hljs-keyword">div</span> <span class="hljs-built_in">class</span>=<span class="hljs-string">"message"</span> data-component=<span class="hljs-string">"message"</span> data-close-selector=<span class="hljs-string">".my-custom-close"</span>&gt;
... &lt;span <span class="hljs-built_in">class</span>=<span class="hljs-string">"my-custom-close small"</span>&gt;&lt;/span&gt;
&lt;/<span class="hljs-keyword">div</span>&gt;
</pre>
<p>Via Javascript:</p>
<pre class="code skip"><span class="hljs-variable">$(</span><span class="hljs-string">'#my-message'</span>).message({
<span class="hljs-symbol">closeSelector:</span> <span class="hljs-string">'.my-custom-close'</span>
});
</pre>
<h3 class="section-head" id="h-methods"><a href="#h-methods">Methods</a></h3>
<p><button onclick="$('#message-1').message('open')">Open</button> <button onclick="$('#message-1').message('close')">Close</button></p>
<div class="message open" data-component="message" data-loaded="true" id="message-1">
You have 2 modules waiting to installation. <a href="#install">Install</a> <span class="close small"></span>
</div>
<table>
<thead>
<tr>
<th>Method</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>close</code></td>
<td>Manually closes a message.</td>
</tr>
<tr>
<td><code>open</code></td>
<td>Opens a message if it has been closed.</td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<pre class="code">$(<span class="hljs-string">'#my-message'</span>).<span class="hljs-keyword">message</span>(<span class="hljs-string">'close'</span>);</pre>
<h3 class="section-head" id="h-callbacks"><a href="#h-callbacks">Callbacks</a></h3>
<table>
<thead>
<tr>
<th>Callback</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>open</code></td>
<td>This event fires immediately when the open instance method is called.</td>
</tr>
<tr>
<td><code>opened</code></td>
<td>This event is fired when the message has been opened, will wait for CSS animation to complete.</td>
</tr>
<tr>
<td><code>close</code></td>
<td>This event fires immediately when the close instance method is called.</td>
</tr>
<tr>
<td><code>closed</code></td>
<td>This event is fired when the message has been closed, will wait for CSS animation to complete.</td>
</tr>
</tbody>
</table>
<h4>Example</h4>
<pre class="code skip">$(<span class="hljs-string">'#my-message'</span>).on(<span class="hljs-string">'closed.message'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>)
</span>{
<span class="hljs-comment">// do something</span>
})
</pre>
23 changes: 23 additions & 0 deletions docs/content/blog/prototyping.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
+++
date = "2017-04-02T22:01:15+01:00"
title = "Prototyping with markdown"
tags = ["markdown","prototype", "hugo"]
categories = ["design"]
description = "An idea to make website protoype with markdown"
draft = false
weight = 30
+++

<img data-src="https://cldup.com/3tov0aCFh8.png" class="lazyload">

I have been working on a large set of documentation for a prototype that will eventually make it into a product. One issue with the publishing system at my company is that it makes doing prototypes, or really anything not within the rigidly and narrowly scoped model, difficult to set up. It takes a lot of work just to get to the point where you can begin writing.

Since time was of the essence and writing is expensive, I decided to do the prototype outside of the publishing system. I also decided to avoid using the rigid DocBook variant we use. Instead, **I figured I do the prototype in Markdown using Hugo generator**. It gives me reasonably ~full featured Markdown support, flexibility to work wherever I want, easy HTML~ ,nd the stack/sheet metaphor fits nicely with topic based writing.


I wasn't sure how well the experiment was going to work when I started, but a few weeks in I think it is great. ~I was able to rapidly prototype fifteen topics in about ten days.~ The prototype pages look fairly close to what our actual system generates. ~I can quickly make changes to the content as needed and republish.~ ~The fact that I can work multi-platform is great. I am not chained to my desk. I can demo changes easily.~


~The fact that I am working in text that doesn't have to be structured in a rigid format makes the work flow faster~. It provides flexibility for quick changes, yet also allows for topic orientation.
For final production and long term maintenance, unstructured Markdown is not a great solution. There the benefits of the rigidity outweigh the cost. The rigidity enforces uniformity that large groups of variously skilled writers need to create and maintain content at scale.
> For small, fast projects or prototyping Markdown, with Hugo, have proven to be an excellent solution.
Loading

0 comments on commit a02bb1f

Please sign in to comment.