<commit_before><p>
Table of Conents
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#using">Getting Started with StackUnderflow.js</a></li>
<li>
    <a href="#api">API Reference</a>
    <ul>
        <li><a href="#appId">stackunderflow.appId</a></li>
        <li><a href="#site">stackunderflow.site</a></li>
        <li><a href="#loaded">stackunderflow.loaded</a></li>
        <li><a href="#google">stackunderflow.googleQuestions</a></li>
        <li><a href="#getQuestions">stackunderflow.getQuestions</a></li>
        <li><a href="#searchQuestions">stackunderflow.searchQuestions</a></li>
        <li><a href="#getQuestionsWithTags">stackunderflow.getQuestionsWithTags</a></li>
        <li><a href="#getQuestionsByUser">stackunderflow.getQuestionsByUser</a></li>
        <li><a href="#renderQuestions">stackunderflow.render.questions</a></li>
    </ul>
</li>
<li><a href="#templating">HTML Templating</a></li>
<li><a href="#css">Customizing CSS</a></li>
</ul>
</p>

<div>
<img src="http://infinity88.com/stackunderflow/stackunderflow.png" />StackUnderflow
</div>

<a name="intro"></a>
<h1>Introduction</h1>
<p>
StackUnderflow.js is a lightweight JavaScript library that makes retrieving and rendering question summary information from StackExchange sites simple. It supports retrieving questions by Question ID, tags, keyword, and even by Google search results to enable you to search the body of questions, even though the StackExchange API does not support it (currently limited to 8 results).
</p>
<p>
Also, because it is hosted and designed to be easily usable from anywhere, it couldn't be easier to get StackExchange data to display on your own websites. Some awesome examples of this capability:
<ul>
<li>Display questions that link to your blog.</li>
<li>Display questions that link to the current blog article.</li>
<li>Display questions related to keyword or tags on a bug tracking site.</li>
<li>Display questions related to a feature directly from online documentation for your products.</li>
</ul>

<p>Here is StackUnderflow.js pulling in questions that link to my blog:</p>
<img src="http://infinity88.com/stackunderflow/StackUnderflowScreen.png" alt="" />
</p>

<a name="using"></a>
<h1>Getting Started with StackUnderflow.js</h1>
<p>
Simply include the script and the default css on your page:
<pre>
&lt;link type="text/css" rel="Stylesheet" href="http://infinity88.com/stackunderflow/stackoverflow.min.css" /&gt;
&lt;script type="text/javascript" src="http://infinity88.com/stackunderflow/stackunderflow-1.0.0.min.js"&gt;&lt;/script&gt;
</pre>
Then, you can immediately start using the API. It will take care of ensuring the document has fully loaded before rendering anything, should you choose to do that.
<pre>
&lt;script type="text/javascript"&gt;
stackunderflow.getQuestionsWithTags("asp.net;viewstate").render("#results");
&lt;/script&gt;
</pre>
</p>

<a name="api"></a>
<h1>API Reference</h1>
<p>
StackUnderflow.js APIs let you search for StackExchange questions using any StackExchange site. You may get the raw data returned from StackExchange to do with what you want, but the real power comes from its render() function, which can render questions in the same familiar summary format you have seen on StackExchange sites already. The look for the rendering is completely customizable, either through CSS, a simple html templating language, or both. By default, the rendering will look like StackOverflow.com, but with your own sites background color.
</p>

<a name="appId"></a>
<h2>stackunderflow.appId (optional)</h2>
<p>
This is a global setting that changes the appId used when querying StackExchange. By default, the key is the appId for StackUnderflow.js. You may wish to set it to your own StackExchange key for tracking and API limit reasons.
<pre>
stackunderflow.appId = "&lt;my app id&gt;";
</pre>
</p>

<a name="site"></a>
<h2>stackunderflow.site (optional)</h2>
<p>
This is a global setting that sets the StackExchange site to query against. Set it to the home url for the site. For example, the default value is "http://stackoverflow.com". Do not include a trailing slash or any other information.<commit_msg>Updated readme with new version<commit_after><p>
Table of Conents
<ul>
<li><a href="#intro">Introduction</a></li>
<li><a href="#using">Getting Started with StackUnderflow.js</a></li>
<li>
    <a href="#api">API Reference</a>
    <ul>
        <li><a href="#appId">stackunderflow.appId</a></li>
        <li><a href="#site">stackunderflow.site</a></li>
        <li><a href="#loaded">stackunderflow.loaded</a></li>
        <li><a href="#google">stackunderflow.googleQuestions</a></li>
        <li><a href="#getQuestions">stackunderflow.getQuestions</a></li>
        <li><a href="#searchQuestions">stackunderflow.searchQuestions</a></li>
        <li><a href="#getQuestionsWithTags">stackunderflow.getQuestionsWithTags</a></li>
        <li><a href="#getQuestionsByUser">stackunderflow.getQuestionsByUser</a></li>
        <li><a href="#renderQuestions">stackunderflow.render.questions</a></li>
    </ul>
</li>
<li><a href="#templating">HTML Templating</a></li>
<li><a href="#css">Customizing CSS</a></li>
</ul>
</p>

<div>
<img src="http://infinity88.com/stackunderflow/stackunderflow.png" />StackUnderflow
</div>

<a name="intro"></a>
<h1>Introduction</h1>
<p>
StackUnderflow.js is a lightweight JavaScript library that makes retrieving and rendering question summary information from StackExchange sites simple. It supports retrieving questions by Question ID, tags, keyword, and even by Google search results to enable you to search the body of questions, even though the StackExchange API does not support it (currently limited to 8 results).
</p>
<p>
Also, because it is hosted and designed to be easily usable from anywhere, it couldn't be easier to get StackExchange data to display on your own websites. Some awesome examples of this capability:
<ul>
<li>Display questions that link to your blog.</li>
<li>Display questions that link to the current blog article.</li>
<li>Display questions related to keyword or tags on a bug tracking site.</li>
<li>Display questions related to a feature directly from online documentation for your products.</li>
</ul>

<p>Here is StackUnderflow.js pulling in questions that link to my blog:</p>
<img src="http://infinity88.com/stackunderflow/StackUnderflowScreen.png" alt="" />
</p>

<a name="using"></a>
<h1>Getting Started with StackUnderflow.js</h1>
<p>
Simply include the script and the default css on your page:
<pre>
&lt;link type="text/css" rel="Stylesheet" href="http://infinity88.com/stackunderflow/stackoverflow.min.css" /&gt;
&lt;script type="text/javascript" src="http://infinity88.com/stackunderflow/stackunderflow-1.0.1.min.js"&gt;&lt;/script&gt;
</pre>
Then, you can immediately start using the API. It will take care of ensuring the document has fully loaded before rendering anything, should you choose to do that.
<pre>
&lt;script type="text/javascript"&gt;
stackunderflow.getQuestionsWithTags("asp.net;viewstate").render("#results");
&lt;/script&gt;
</pre>
</p>

<a name="api"></a>
<h1>API Reference</h1>
<p>
StackUnderflow.js APIs let you search for StackExchange questions using any StackExchange site. You may get the raw data returned from StackExchange to do with what you want, but the real power comes from its render() function, which can render questions in the same familiar summary format you have seen on StackExchange sites already. The look for the rendering is completely customizable, either through CSS, a simple html templating language, or both. By default, the rendering will look like StackOverflow.com, but with your own sites background color.
</p>

<a name="appId"></a>
<h2>stackunderflow.appId (optional)</h2>
<p>
This is a global setting that changes the appId used when querying StackExchange. By default, the key is the appId for StackUnderflow.js. You may wish to set it to your own StackExchange key for tracking and API limit reasons.
<pre>
stackunderflow.appId = "&lt;my app id&gt;";
</pre>
</p>

<a name="site"></a>
<h2>stackunderflow.site (optional)</h2>
<p>
This is a global setting that sets the StackExchange site to query against. Set it to the home url for the site. For example, the default value is "http://stackoverflow.com". Do not include a trailing slash or any other information.
{'fraction_non_alphanumeric': 0.13063279002876318, 'fraction_numerical': 0.0052732502396931925, 'mean_word_length': 5.077931536780772, 'pattern_counts': {'":': 0, '<': 233, '<?xml version=': 0, '>': 233, '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': '6354987', 'n_tokens_mistral': 2513, 'n_tokens_neox': 2428, 'n_words': 909}