122 lines
2.8 KiB
Markdown
122 lines
2.8 KiB
Markdown
# [samuel.forestier.app](https://samuel.forestier.app/)
|
|
|
|
> What a personal _Jekyll_ blog :100:
|
|
|
|
## Deploy it locally
|
|
|
|
### Fetch the sources
|
|
|
|
```bash
|
|
git clone git@git.forestier.app:HorlogeSkynet/blog.git
|
|
cd blog/
|
|
```
|
|
|
|
### Install requirements
|
|
|
|
```bash
|
|
apt install -y g++ make gem ruby-dev zlib1g-dev
|
|
```
|
|
|
|
### Provision Ruby environment
|
|
|
|
```bash
|
|
gem install \
|
|
--no-document \
|
|
--install-dir .gem/ \
|
|
jekyll \
|
|
jemoji \
|
|
jekyll-seo-tag \
|
|
jekyll-sitemap \
|
|
jekyll-redirect-from \
|
|
jekyll-mentions \
|
|
jekyll-paginate-v2
|
|
```
|
|
|
|
### Run the development server
|
|
|
|
```bash
|
|
export GEM_HOME=.gem; $GEM_HOME/bin/jekyll serve
|
|
```
|
|
|
|
Congratulations, you can now go to <http://127.0.0.1:4000/> :tada:
|
|
|
|
## How to contribute ?
|
|
|
|
### Project architecture
|
|
|
|
* Posts are placed under `_posts/` folder, and their respective images under `_img/` folder
|
|
|
|
* Styles and scripts assets are respectively under `css/` and `js/` folders
|
|
|
|
### Cool stuffs available here
|
|
|
|
* Post last modified date :
|
|
```yaml
|
|
---
|
|
last_modified_at: 2012-12-12 12:12
|
|
---
|
|
```
|
|
|
|
* Disable comments section per post with :
|
|
```yaml
|
|
---
|
|
comments: false
|
|
---
|
|
```
|
|
|
|
* Publish a post as draft (not referenced anywhere) :
|
|
```yaml
|
|
---
|
|
draft: true
|
|
sitemap: false
|
|
---
|
|
```
|
|
|
|
* Set a static link to a post or a page (in addition to its default permalink) :
|
|
```yaml
|
|
---
|
|
redirect_from: /my-cool-link
|
|
---
|
|
```
|
|
|
|
* Add a reference to a _GitHub_ user profile within a post or a page :
|
|
```markdown
|
|
This is a pretty **cool post** written by @HorlogeSkynet !
|
|
```
|
|
|
|
* Create an images gallery :
|
|
```twig
|
|
{% include gallery.html URIs='your-post-name_1.png;your-post-name_2.jpg;your-post-name_3.jpeg' %}
|
|
```
|
|
|
|
* Add a video withing an `<iframe>` tag :
|
|
```twig
|
|
{% include video.html URL='https://your.video.provider/video_id' %}
|
|
```
|
|
|
|
* Add a music from _SoundCloud_ or _Spotify_ :
|
|
```twig
|
|
{% include soundcloud.html track_id='your_track_id' %}
|
|
<!-- ... -->
|
|
{% include spotify.html track_id='your_track_id' %}
|
|
```
|
|
|
|
* Add a right-padding to a _FontAwesome_ icon (automatically left-padded) :
|
|
```html
|
|
<i class="fas fa-forward right"></i>
|
|
```
|
|
|
|
## Acknowledgments
|
|
|
|
This website is built upon :
|
|
|
|
* [Jekyll](https://jekyllrb.com/)
|
|
* [Isso](https://posativ.org/isso/)
|
|
* [FontAwesome](https://fontawesome.com/)
|
|
* [Auto-Hiding Navigation](https://codyhouse.co/gem/auto-hiding-navigation/), by Claudia Romano
|
|
* [Vertical Timeline](https://codyhouse.co/gem/vertical-timeline/), by Sebastiano Guerriero
|
|
* [Simple Jekyll Search](https://github.com/christian-fei/Simple-Jekyll-Search), by Christian Fei
|
|
* [Atom and JSON feeds](http://runningblind.com/2018/12/22/jekyll-jekyll-feed-you-don-t-need-it/), by Josh Goebel
|
|
|
|
Thanks (again !) to [@NAERNON](https://github.com/NAERNON) for its [wonderful favicon](img/favicon/favicon.svg).
|