<commit_before>---
title: README
---

<h1 class="md-display-3">README</h1>

<div layout="row">
  <p class="md-body-1">
    <strong>README</strong> is a <em>common documentation generator</em>.
    Its purpose is to quickly generate documentation for a project so you can jump
    right into development knowing the core of your project is already documented
    for you.
  </p>
</div>

<div layout="row">
  <p class="md-body-1">
    It primarily supports <em>quick, simple projects</em> for epically bootstrapped documentation.
  </p>
</div>

<hr />

<div ng-controller="DemoCtrl" layout="column" ng-cloak>
  <md-content layout="row" layout-padding>
    <md-input-container style="width: 50%">
      <label>Project Name</label>
      <input ng-model="doc.title">
    </md-input-container>
    </md-content>
    <md-content layout="row" layout-padding>
    <md-input-container style="width: 70%">
      <label>Short Description</label>
      <input ng-model="doc.desc">
    </md-input-container>
    </md-content>
    <md-content layout="row" layout-padding>
    <md-input-container style="width: 50%">
      <label>Purpose Header</label>
      <input ng-model="doc.purposeHeader">
    </md-input-container>
    </md-content>
    <md-content layout="row" layout-padding>
    <md-input-container style="width: 70%">
      <label>Purpose Description</label>
      <textarea ng-model="doc.purposeDesc" ng-model-options="{ getterSetter: true }"></textarea>
    </md-input-container>
  </md-content>

  <div layout="row">
    <div id="output" style="width: 50%">
      # <span ng-bind="doc.title"></span>
      <br /><br />
      <span ng-bind="doc.desc"></span>
      <br /><br />
      ## <span ng-bind="doc.purposeHeader"></span>
      <br /><br />
      <span ng-bind-html="doc.purposeDescHTML()"></span>
    </div>

    <div id="preview" class="markdown-body" style="width: 50%">
      <h1 ng-bind="doc.title"></h1>
      <p ng-bind="doc.desc"></p>
      <h2 ng-bind="doc.purposeHeader"></h2>
      <p ng-bind-html="doc.purposeDescHTML()"></p>
    </div>
  </div>
</div>
<commit_msg>cleanup layout, use tabs for preview & markdown<commit_after>---
title: README
---

<h1 class="md-display-3">README</h1>

<div layout="row">
  <p class="md-body-1">
    <strong>README</strong> is a <em>common documentation generator</em>.
    Its purpose is to quickly generate documentation for a project so you can jump
    right into development knowing the core of your project is already documented
    for you.
  </p>
</div>

<div layout="row">
  <p class="md-body-1">
    It primarily supports <em>quick, simple projects</em> for epically bootstrapped documentation.
  </p>
</div>

<hr />

<div ng-controller="DemoCtrl" layout="row" layout-align="space-around" ng-cloak>
  <div layout="column" flex="50">
    <div layout="row" layout-padding>
      <md-input-container flex="100">
        <label>Project Name</label>
        <input ng-model="doc.title">
      </md-input-container>
    </div>
    <div layout="row" layout-padding>
      <md-input-container flex="100">
        <label>Short Description</label>
        <input ng-model="doc.desc">
      </md-input-container>
    </div>
    <div layout="row" layout-padding>
      <md-input-container flex="100">
        <label>Purpose Header</label>
        <input ng-model="doc.purposeHeader">
      </md-input-container>
    </div>
    <div layout="row" layout-padding>
      <md-input-container flex="100">
        <label>Purpose Description</label>
        <textarea ng-model="doc.purposeDesc" ng-model-options="{ getterSetter: true }"></textarea>
      </md-input-container>
    </div>
  </div>

  <md-tabs layout="column" flex="50">
    <md-tab label="Preview">
      <div id="preview" class="markdown-body md-padding">
        <h1 ng-bind="doc.title"></h1>
        <p ng-bind="doc.desc"></p>
        <h2 ng-bind="doc.purposeHeader"></h2>
        <p ng-bind-html="doc.purposeDescHTML()"></p>
      </div>
    </md-tab>
    <md-tab label="Markdown">
      <div id="output" class="md-padding" style="width: 50%">
        # <span ng-bind="doc.title"></span>
        <br /><br />
        <span ng-bind="doc.desc"></span>
        <br /><br />
        ## <span ng-bind="doc.purposeHeader"></span>
        <br /><br />
        <span ng-bind-html="doc.purposeDescHTML()"></span>
      </div>
    </md-tab>
  </md-tabs>
</div>

{'fraction_non_alphanumeric': 0.18729940394314534, 'fraction_numerical': 0.011004126547455296, 'mean_word_length': 2.9094982078853047, 'pattern_counts': {'":': 0, '<': 161, '<?xml version=': 0, '>': 161, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3060977', 'n_tokens_mistral': 1514, 'n_tokens_neox': 1449, 'n_words': 324}