Initial commit
This commit is contained in:
commit
530fc76ede
84 changed files with 60305 additions and 0 deletions
49
README.md
Normal file
49
README.md
Normal file
|
@ -0,0 +1,49 @@
|
|||
# Homepage
|
||||
|
||||
This repository contains all the code that I use to host my website. Pages are written in markdown and are rendered to
|
||||
static HTML using Jekyll and a custom Bootstrap theme that I created.
|
||||
|
||||
## Installing dependencies
|
||||
|
||||
Based on the [Jekyll quick start guide](https://jekyllrb.com/docs/)
|
||||
|
||||
**Note:** Make sure Ruby and RubyGems are installed
|
||||
|
||||
1. Install the jekyll and bundler gem packages
|
||||
```shell
|
||||
gem install jekyll bundler
|
||||
```
|
||||
|
||||
2. Install site dependencies
|
||||
|
||||
**Make sure you are in the root directory of the git repository**
|
||||
```shell
|
||||
bundle install
|
||||
```
|
||||
|
||||
## Building the static site
|
||||
|
||||
Static HTML and CSS files can be built using the following command.
|
||||
|
||||
```shell
|
||||
bundle exec jekyll build
|
||||
```
|
||||
|
||||
All static files should now be in the ```site/``` directory.
|
||||
|
||||
## Important note:
|
||||
|
||||
The static site's root is ``_site/``. Everything outside of that is processed by Jekyll and placed in `_site/`.
|
||||
|
||||
**Note:** Some of the final code in ``_site`` may not have proper indentation, and some comments might have been
|
||||
removed.
|
||||
|
||||
## Sources I used in a bunch of places
|
||||
|
||||
- [W3Schools](https://www.w3schools.com/)
|
||||
- [MDN](https://developer.mozilla.org/en-US/)
|
||||
- [Bootstrap Docs](https://getbootstrap.com/docs/5.3/getting-started/introduction/)
|
||||
- [Bootstrap Examples](https://getbootstrap.com/docs/5.3/examples/)
|
||||
- [Jekyll Documentation](https://jekyllrb.com/docs/)
|
||||
- [Liquid Documentation](https://shopify.github.io/liquid/)
|
||||
- [SASS Documentation](https://sass-lang.com/guide)
|
Loading…
Add table
Add a link
Reference in a new issue