Added mkdocs generated website using the book's material

sugatoray commented 2 years ago

What type of PR is this? (check all applicable)

[x] ♻️ Refactor: :green_circle: Y (some extra content is added for the website: this does not change the book's contents)
[x] ✨ New Chapter :orange_circle: Not Applicable
[x] 🐛 Bug Fix/Typo :orange_circle: Not Applicable
[x] 👷 Optimization :orange_circle: Not Applicable
[x] 📝 Documentation Update :green_circle: Y
[x] 🚩 Other Website :green_circle: Y

Description

A brand new website is made to host the contents of the book as an ebook. A current version is hosted here as an example. A few other setup steps are necessary from the repo owner: @bobbyiliev

Check out the Web ebook :blue_book: :star:

After the PR is merged you will need to do the following to publish the docs to GitHub Pages.
Goto repo settings and click on "Pages". Select the branch "gh-pages" and select location as ./root. And save it.
If you want the fontawesome-icons to show on the site, please get a free fontawesome kit after signing up for a free account.

Related Tickets & Documents

This closes #273.

Added to documentation?

[x] 📜 readme :orange_circle: Not Applicable
[x] 🙅 no documentation needed

sugatoray commented 2 years ago

There is a github action (.github/workflows/mkdocs-publish-ghpages.yml) which takes care of publishing the contents of the website to another branch: gh-pages. The GitHub Pages feature, if enabled on the repository, then would make available the website at:

https://bobbyliev.github.io/101-linux-commands-ebook

Sample Outline of the GitHUb Action

You can inspect the details of the action run here. :bulb:

cc: @bobbyiliev

bobbyiliev commented 2 years ago

Hi @sugatoray this looks awesome! Just merged it, but seems like the build is failing. Do you have any ideas on why this could be happening?

sugatoray commented 2 years ago

Let me take a look at it later today. Can you share a link to the build failure here?

bobbyiliev commented 2 years ago

Thank you! Yep it is this one here: https://github.com/bobbyiliev/101-linux-commands-ebook/runs/4035360615

sugatoray commented 2 years ago

Hi @bobbyiliev,

Thank you! Yep it is this one here: bobbyiliev/101-linux-commands-ebook/runs/4035360615

You need to first setup your GitHub pages. Then you will be able to access your own homepage at https://bobbyliev.github.io/. This repository's docs will be available given your own github pages are configured first. To set it up, please follow along this tutorial: https://pages.github.com/. It's a one-time activity only.

sugatoray commented 2 years ago

@bobbyiliev Were you able to setup your github pages?

bobbyiliev / 101-linux-commands-ebook