https://github.com/tolk-vm/howto-site-on-github

Demo of using github as your static site server — a bit more complex than plain HTML, thanks to jekyll
https://github.com/tolk-vm/howto-site-on-github

html jekyll markdown server-side

Last synced: 7 days ago
JSON representation

Demo of using github as your static site server — a bit more complex than plain HTML, thanks to jekyll

• Host: GitHub
• URL: https://github.com/tolk-vm/howto-site-on-github
• Owner: tolk-vm
• License: gpl-3.0
• Created: 2020-09-06T08:01:11.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-06T17:19:43.000Z (over 4 years ago)
• Last Synced: 2024-12-03T04:37:21.036Z (2 months ago)
• Topics: html, jekyll, markdown, server-side
• Homepage: https://unserialize.github.io/howto-site-on-github/
• Size: 40 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Demo of using github as a hosting, but content is more complex than just plain html. 

[**Here it is**](https://unserialize.github.io/howto-site-on-github)

## Purpose

This project shows **a minimal setup** for writing documentation for your github project.

Stored in the same repo **in /docs/ folder**, it is available on *<username>.github.io/<project>*.

Its content is not plain html/markdown — it is complicated, with same header/footer, variables usage, scss and so on —

but it remains a static site than can be hosted on github pages and easily tested locally.

So, finally it has **no server-side logic**, but client-side is much smarted than just bare html.

All this is done using [**jekyll**](https://jekyllrb.com/): github pages uses it under the hood. 

## Quickstart your project 

[Instruction](https://unserialize.github.io/howto-site-on-github/setup).

## Serving this website locally

1. `git clone` this repo

2. Make sure ruby, bundle and other [prerequisites](https://docs.github.com/en/github/working-with-github-pages/creating-a-github-pages-site-with-jekyll) are installed

3. `cd docs`

4. `jekyll serve`, and *http://127.0.0.1:4000/howto-site-on-github/* should work