Wrote readme and created example markdown

Author: ddieruf

README.md

@@ -1,53 +1,59 @@
-# Pulsar Neightborhood web site
-Welcome to the home for the [Pulsar Neighborhood site](https://pulsar-neighborhood.com).
+# Pulsar Neighborhood web site
+Welcome to the home for the [Pulsar Neighborhood site](https://pulsar-neighborhood.com). This is the source behind the magic. As an open community we welcome all ideas and contributions, whether it is a new feature on the site or content you would like to see.
 
 ## About the site's framework
 
-## Contributing articles, guides, ideas and everything else
+Pulsar Neighborhood was created on the [Hugo framework](https://gohugo.io/). It uses bootstrap components to create the wondrous experience that is. There is a mix of core Hugo functions, good ideas from seasoned Hugo experts, as well as the odd idea found out in the wild. We try to follow the best practices of Hugo when it comes to the site's folder structure and naming. If you are familiar with the framework, then this site is [hopefully] very easy to get started with.
 
-Got a idea of a topic others might be interested in? Want to share your learnings about Pulsar with the commnity?
+If you see something about the site's design that could be a little better please [make a suggestion](https://github.com/pulsar-neighborhood/pulsar-neighborhood.github.io/issues) or PR that great idea right in to the project.
 
-Head over to the issues tab and open the appropriate type. This will provide a simple template you can follow to make sure everything is in line.
+It was chosen to keep the original content type of `page` and create 3 new layouts: article, guide, and spotlight. Articles are the most common and represent a blog post, video, or some other written story about Pulsar. Guides are step by step instructions on how to achieve some goal using Pulsar. Spotlight is a special type used for the community spotlight section of the site.
 
-Once submitted a site contributor will be in contact with next steps.
+## "I love the spotlight" - said no software engineer, ever
 
+ Don't sweat this. It's less about you and more about what you've done with Pulsar. If you've got something to share but don't feel like writing it all out let's put it in the spotlight. [Open a spotlight issue](https://github.com/pulsar-neighborhood/pulsar-neighborhood.github.io/issues/new?assignees=&labels=&template=community-member-spotlight.md&title=Check%20my%20Pulsar%20skillz) and give us a sentence or two about the cool things you've done. Share a link if it's something public.
 
-## Contributing content
 
-The site has two different type of content - articles and guides. Articles can be thought of as a blog post but could have code snippets. Generally 
+## Contributing ideas and content
 
-If you have ideas of content you would like to see on the site, 
+It can be a simple idea, a written article, or a half though-out step by step guide. However far along the content is, the community is here to help make it a pulitzer candidate.  Your options...
 
-## Content formatting examples
+### Opening an issue (simplest)
 
-### Tabs
-{{< tabs tabTotal="4">}}
-{{< tab tabName="C#" >}}
+When you [open an issue](https://github.com/pulsar-neighborhood/pulsar-neighborhood.github.io/issues/new/choose) in the repo you are asked to choose from a template. Use this to choose the type of content the best fits your idea. Paste your markdown within the "content" area of the new issue or simply type out a few lines of idea. There are a few additional areas of interest like title, author info, image, etc. All of this is optional. A content moderator will guide you through getting everything right.
 
-```csharp
-public void DoSomehting(){
-    return;
-}
-```
 
-{{< /tab >}}
-{{< tab tabName="Java" >}}
+### Running the site locally
+
+If you're feeling adventurous (and have a basic understanding of Hugo) you could fork the repo and develop your idea locally. Then open a pull request to suggest the idea in the main site. Below are commands you can use to get content started:
 
-```java
-public void DoSomehting(){
-    return;
-}
+Create a new article:
+```bash
+hugo new articles/my-really-great-idea.md
 ```
 
-{{< /tab >}}
-{{< tab tabName="Go">}}
+Create a new guide:
+```bash
+hugo new guides/my-step-by-step-guide.md
+```
+## Content formatting examples
+
+As you write content for the community use the below markdown examples to take things to the next level. Spoiler - no one likes a wall of text and everyone loves reading code.
+
+[Guide steps](content/examples/guide.md) - use this to get a step by step guide started
+
+[Tabs](content/examples/tabs.md) - share your code in multiple runtimes
+
+[Code Snippets](content/examples/code-snippet.md) - include snippets throughout your content, maybe even highlight a line and comment on it
+
+[Blockquotes](content/examples/blockquote.md) - make a statement
+
+[Information Callout](content/examples/info-callout.md) - include a call out box with further info about a topic
 
-**Go Content**
+[Warning Callout](content/examples/warn-callout.md) - include a call out box with fair warning about something
 
-{{< /tab >}}
-{{< tab tabName="Python">}}
+[Danger Callout](content/examples/danger-callout.md) - include a call out box that warns of dragons or ill-tempered creatures ahead
 
-**Python Content**
+[Success Callout](content/examples/success-callout.md) - include a call out box declaring a win
 
-{{< /tab >}}
-{{< /tabs >}}
+[Table](content/examples/table.md) - markdown tables aren't the best, use this to go a little further

content/examples/blockquote.md

@@ -0,0 +1,3 @@
+This is an example page showing how to use markdown on the Pulsar Neighborhood site to include a blockquote element.
+
+> This is something super meaningful

content/examples/code-snippet.md

@@ -0,0 +1,34 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to include code snippets in content.
+
+A very basic snippet:
+```csharp
+public void DoSomething()
+{
+    return;
+}
+```
+
+A more involved snippet using Hugo's [built-in highlighting](https://gohugo.io/content-management/syntax-highlighting/). Now you can call out what is happening in the highlighted lines while still giving the overall functional context.
+
+{{< highlight go "linenos=table,hl_lines=8 15-17,linenostart=199" >}}
+// GetTitleFunc returns a func that can be used to transform a string to
+// title case.
+//
+// The supported styles are
+//
+// - "Go" (strings.Title)
+// - "AP" (see https://www.apstylebook.com/)
+// - "Chicago" (see https://www.chicagomanualofstyle.org/home.html)
+//
+// If an unknown or empty style is provided, AP style is what you get.
+func GetTitleFunc(style string) func(s string) string {
+  switch strings.ToLower(style) {
+  case "go":
+    return strings.Title
+  case "chicago":
+    return transform.NewTitleConverter(transform.ChicagoStyle)
+  default:
+    return transform.NewTitleConverter(transform.APStyle)
+  }
+}
+{{< / highlight >}}

content/examples/danger-callout.md

@@ -0,0 +1,5 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to include code snippets in content.
+
+{{< danger >}}
+There be dragons
+{{< /danger >}}

content/examples/guide.md

@@ -0,0 +1,5 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to include code snippets in content.
+
+{{< info >}}
+This is information that you need to know.
+{{< /info >}}

content/examples/info-callout.md

@@ -0,0 +1,5 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to include code snippets in content.
+
+{{< success >}}
+Haazaa you've done it!
+{{< /success >}}

content/examples/success-callout.md

@@ -0,0 +1,23 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to create tabbed information.
+
+{{<table table_class="table table-striped table-bordered">}}
+
+| Animal  | Sounds |
+|---------|--------|
+| Cat     | Meow   |
+| Dog     | Woof   |
+| Cricket | Chirp  |
+
+{{</table>}}
+
+A table with more formatting
+
+{{<table table_class="table table-sm table-primary" thead_class="thead-dark" caption="These are sounds">}}
+
+| Animal  | Sounds |
+|---------|--------|
+| Cat     | Meow   |
+| Dog     | Woof   |
+| Cricket | Chirp  |
+
+{{</table>}}

content/examples/table.md

@@ -0,0 +1,45 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to create tabbed information.
+
+{{< tabs tabTotal="4">}}
+{{< tab tabName="C#" >}}
+
+```csharp
+public void DoSomething()
+{
+    return;
+}
+```
+
+{{< /tab >}}
+{{< tab tabName="Java" >}}
+
+```java
+public Integer getLength(String str)
+{
+    return str.length();
+}
+```
+
+{{< /tab >}}
+{{< tab tabName="Go">}}
+
+```golang
+func plusPlus(a, b, c int) int
+{
+    return a + b + c
+}
+```
+
+{{< /tab >}}
+{{< tab tabName="Python">}}
+
+```python
+def greet(name):
+    """
+    This function greets to the person passed in as a parameter
+    """
+    print("Hello, " + name + ". Good morning!")
+```
+
+{{< /tab >}}
+{{< /tabs >}}

content/examples/tabs.md

@@ -0,0 +1,5 @@
+This is an example page showing how to use Hugo shortcodes on the Pulsar Neighborhood site to include code snippets in content.
+
+{{< warning >}}
+You now have fair warning to not make that mistake
+{{< /warning >}}