Skip to content

Commit

Permalink
fix markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
s-martin committed Jun 2, 2024
1 parent 090400d commit a193a31
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 29 deletions.
50 changes: 24 additions & 26 deletions _posts/2020-01-12-blog-with-jekyll.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -5,49 +5,47 @@ date: 2020-01-12 20:00:00 +0100
categories: github jekyll
---

I have decided to use a blog to store descriptions for my hobby projects. While I have a server I decided
not to use it for blogging, because I don't want to maintain it.
I have decided to use a blog to store descriptions for my hobby projects. While I have a server I decided not to use it for blogging, because I don't want to maintain it.

I have a [Github][github] account, so I used [Github Pages][github-pages] together with [Jekyll][jekyll].

Here's a description how I did it on Windows with WSL and Visual Studio Code.

# Installation #
# Installation

1. Create a Github repository with the following name `https://github.com/YourUsername/YourUsername.github.io`, see also [here][github-pages].
2. Clone the repo locally to your machine.
3. Open your WSL command prompt.
4. Install Ruby development tools, if necessary, see also [here][jekyll-docs]. E.g. `sudo apt install ruby-dev`
5. Install needed gems with `sudo gem install jekyll bundler github-pages`
6. Change directory to the local copy of the repo
7. Create a new Jekyll site here with `jekyll new .`
8. I use [Visual Studio Code][vscode] with the extension [Markdown All In One][markdown-plugin]. Open directory in Visual Studio Code.
9. Add to the `Gemfile`
1. Clone the repo locally to your machine.
1. Open your WSL command prompt.
1. Install Ruby development tools, if necessary, see also [here][jekyll-docs]. E.g. `sudo apt install ruby-dev`
1. Install needed gems with `sudo gem install jekyll bundler github-pages`
1. Change directory to the local copy of the repo
1. Create a new Jekyll site here with `jekyll new .`
1. I use [Visual Studio Code][vscode] with the extension [Markdown All In One][markdown-plugin]. Open directory in Visual Studio Code.
1. Add to the `Gemfile`

{% highlight Gemfile %}
~~~gem
source "https://rubygems.org"
gem "github-pages", group: :jekyll_plugins
~~~
source "https://rubygems.org"
1. Customize `_config.yml`, e.g. title, description, email, etc.
1. Run `bundle install` and `bundle update`
gem "github-pages", group: :jekyll_plugins
# Blogging
{% endhighlight %}

10. Customize `_config.yml`, e.g. title, description, email, etc.
11. Run `bundle install` and `bundle update`

# Blogging #
1. To add a new blog post, add a file `2020-01-12-blogposttitle.markdown` (change accordingly) to the sub-directory `_posts`. See existing files for hints how to format.
2. Start blogging as markdown files.
3. Build the site and make it available locally with `bundle exec jekyll serve --no-watch`
4. You can now open the blog in your browser at `http://127.0.0.1:4000`.
1. Start blogging as markdown files.
1. Build the site and make it available locally with `bundle exec jekyll serve --no-watch`
1. You can now open the blog in your browser at `http://127.0.0.1:4000`.
# Publish at Github
# Publish at Github #
1. Git Commit and Push all files to your Github repo.
2. Github builds the page and after a couple of minutes it should be available at https://YourUsername.github.io
1. Github builds the page and after a couple of minutes it should be available at <https://YourUsername.github.io>
[github]: https://github.com/
[github-pages]: https://pages.github.com/
[jekyll]: https://jekyllrb.com/
[jekyll-docs]: https://jekyllrb.com/docs/
[vscode]: https://code.visualstudio.com/
[markdown-plugin]: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
[markdown-plugin]: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one
3 changes: 0 additions & 3 deletions _posts/2020-01-16-pam8406.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ Package Contents:

1 x PAM8406 5W+5W Class D Stereo Audio Power Amplifier Module with Volume Control Potentiometers




[github]: https://github.com/
[github-pages]: https://pages.github.com/
[jekyll]: https://jekyllrb.com/
Expand Down

0 comments on commit a193a31

Please sign in to comment.