Update README.md

README.md

@@ -9,45 +9,52 @@ task_categories:
 - text2text-generation
 tags:
 - code
-pretty_name: StackOverflow Posts
+pretty_name: StackOverflow Posts Markdown
 size_categories:
 - 10M<n<100M
 ---
 
-# Dataset Summary
+# StackOverflow Posts Markdown
+
+![StackOverflow Logo](https://stackoverflow.design/assets/img/logos/so/logo-stackoverflow.png)
+
+
+## Dataset Summary
 
 This dataset contains all posts submitted to StackOverflow before the 14th of June 2023 formatted as **Markdown text**.<br>
 The dataset contains over 60 Million posts, totaling ~40GB in size and ~65 billion characters of text.<br>
 The data is sourced from [Internet Archive StackExchange Data Dump](https://archive.org/download/stackexchange).
 
-# Data Fields
-```
-Id: long,
-PostTypeId: long
-AcceptedAnswerId long | null,
-ParentId: long | null,
-Score: long,
-ViewCount: long | null,
-Body: string | null,
-Title: string | null
-ContentLicense: string | null,
-FavoriteCount: long | null,
-CreationDate: string | null,
-LastActivityDate: string | null,
-LastEditDate: string | null,
-LastEditorUserId: long | null,
-OwnerUserId: long | null
-Tags: array&lt;string&gt; | null
+## Data Fields
+```typescript
+{
+  Id: long,
+  PostTypeId: long
+  AcceptedAnswerId: long | null,
+  ParentId: long | null,
+  Score: long,
+  ViewCount: long | null,
+  Body: string | null,
+  Title: string | null
+  ContentLicense: string | null,
+  FavoriteCount: long | null,
+  CreationDate: string | null,
+  LastActivityDate: string | null,
+  LastEditDate: string | null,
+  LastEditorUserId: long | null,
+  OwnerUserId: long | null
+  Tags: array<string> | null
+}
 ```
 
-# How is the text stored?
+## How is the text stored?
 
 The original Data Dump formats the "Body" field as html, using tags such as `<code>`, `<h1>`, `<ul>`, etc.
 This HTML format has been converted to markdown 
 
 [This post](https://stackoverflow.com/questions/53253940/make-react-useeffect-hook-not-run-on-initial-render) is contained in the dataset formatted as follows:
 
-## Body of an example record
+### Body of an example record
 ```markdown
 According to the docs:
 
@@ -82,7 +89,7 @@ function ComponentDidUpdateFunction() {
 
 ```
 
-# Details on the HTML to Markdown conversion
+## Details on the HTML to Markdown conversion
 
 Using Jsoup, the original Body field was converted into a Jsoup Document. This child **nodes** (has special meaning in context of Jsoup) of this document were recursively traversed in a depth-first order.
 
@@ -96,7 +103,7 @@ Additionally the existence of the `TextNode` should be noted, which represents f
 Thus this text tag `<p>Hello<code>World</code></p>` would have two Jsoup child nodes `TextNode(value="Hello")` and Element(tag="code", value="World")`.
 The value `field` of a `TextNode` contains the free standing text without any further treatment (no whitespace stripping, etc.)
 
-## Traversing Rules
+#### Traversing Rules
 
 - When ecountering a html tag for which a rule exists, children are not further traversed, **unless explicitly stated otherwise**.
 - When encountering an `<a>` tag, `[${element.text()}](${element.attr("href")})` is emitted.
@@ -131,5 +138,4 @@ The value `field` of a `TextNode` contains the free standing text without any fu
 - When encountering a jsoup `TextNode`, `${node.attr(node.nodeName())}` (which is equivalent to accessing the private field `node.value`) is emitted.
 
 
-```
-
+```