diff --git a/.gitignore b/.gitignore index 6704566..bae8f2e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +/build +/dist +/tmp + # Logs logs *.log diff --git a/.prettierrc.json b/.prettierrc.json index e69de29..b3b052f 100644 --- a/.prettierrc.json +++ b/.prettierrc.json @@ -0,0 +1,3 @@ +{ + "tabWidth": 2 +} diff --git a/README.md b/README.md index 3e33be4..3aded54 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,97 @@ Intentional Markdown blog template - Lightweight, yet Sophisticated. [![](https://user-images.githubusercontent.com/122831/113492733-e735cc80-9496-11eb-8787-43fee2671891.jpg)](https://www.youtube.com/watch?v=LlYrvZuIYUQ&list=PLxki0D-ilnqZfyo2dZe11ZNGP7RJxJcoA&index=11&rel=0) +## How to Use Beyond Theme + +1. Download both stylesheets: + + ```bash + curl -LO https://raw.githubusercontent.com/BeyondCodeBootcamp/beyond-blog-template/main/assets/github-markdown.css + + curl -LO https://raw.githubusercontent.com/BeyondCodeBootcamp/beyond-blog-template/main/assets/beyond-theme.css + ``` + +2. Include them in the `` of your html: + + ```html + + + ``` + +Example: + +```html + + + + + + + + + + + + + +``` + +## How to use the Beyond Markdown Article + +Inside of your `` create an `
` with the rendered Markdown output. + +```html +
+ +

Hello

+
    +
  1. One
    2. +
  2. Two
    3. +
  3. Three
    4. +
+
+``` + +## How to use the Beyond Header + +Create a `