diff --git a/README.md b/README.md index 8c46d8b1c..c35e44c05 100644 --- a/README.md +++ b/README.md @@ -3,34 +3,34 @@ Haiku Project website This repository contains the source code for Haiku's main website. ## Blogging -To create a new blog for a new user, run `./scripts/newblog.sh`. +To create a brand new blog for a new user, run `./scripts/newblog.sh`. -To create a new blogpost, run `./scripts/newpost.sh`. +To create a brand new blogpost, run `./scripts/newpost.sh`. Refer Troubleshooting section if you encounter any error. ## Shortcodes -Shortcodes introduce the ability to leverage special formatting +Shortcodes introduce the power to leverage special formatting in markdown documents. All available shortcodes are in layouts/shortcodes. ### Alerts A classic alert or notification div with a title and a body - * ``{{< alert-danger "Title" "Body text here">}}`` - * ``{{< alert-warning "Title" "Body text here">}}`` - * ``{{< alert-info "Title" "Body text here">}}`` + * ``{{< alert-danger "Title" "Body text here">}}`` + * ``{{< alert-warning "Title" "Body text here">}}`` + * ``{{< alert-info "Title" "Body text here">}}`` ### Keyboard -A small keyboard like span. Normally used to represent pressing +A small keyboard like span. Normally wont to represent pressing a physical key on the keyboard. - * ``{{< keyboard ALT >}}`` + * ``{{< keyboard ALT >}}`` ## Troubleshooting ### macOS: "date: illegal option" -This is because OS X/macOS and Linux use two different sets of tools. Linux uses the GNU version of the date command (hence, GNU/Linux). The solution would be to install GNU Core Utilities replacing macOS Utilities: +This is because OS X/macOS and Linux use two different sets of tools. Linux uses the GNU version of the date command (hence, GNU/Linux). the answer would be to install GNU Core Utilities replacing macOS Utilities: *Homebrew:*