https://github.com/weakish/micro-gh-page
micro github pages repository template
https://github.com/weakish/micro-gh-page
github-pages-template jekyll-template static-site-boilerplate
Last synced: 7 months ago
JSON representation
micro github pages repository template
- Host: GitHub
- URL: https://github.com/weakish/micro-gh-page
- Owner: weakish
- License: other
- Created: 2019-11-23T08:31:12.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T01:50:45.000Z (over 5 years ago)
- Last Synced: 2025-01-12T18:11:57.343Z (about 1 year ago)
- Topics: github-pages-template, jekyll-template, static-site-boilerplate
- Language: CSS
- Homepage: https://weakish.github.io/micro-gh-page
- Size: 28.3 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Micro GitHub Page Template
## Features
0. No JavaScript.
1. Minimalistic 404 page.
2. Clean urls (`/page/` instead of `/page.html`).
3. SEO sitemap.
4. Use `/commits/master.atom` of source repository for RSS.
5. `application/git+http` rel tag.
6. Use [Primer] Jekyll theme, which is the default theme for GitHub Pages
[Primer]: https://github.com/pages-themes/primer
## Use
1. Create a new repository at GitHub based on template [weakish/micro-gh-page].
2. Edit `_config.yml`, for example:
```
url: your-username.github.io
title: your-site-title
```
3. (optional) Add a `favicon.ico` file.
4. (optional) Add a `CNAME` file to use your own domain.
5. (optional) Add `repo: USERNAME/REPO_NAME` in `_config.yml`.
6. Commit changes and push.
[weakish/micro-gh-page]: https://github.com/weakish/micro-gh-page
## Preview
Install the requirements:
```sh
bundle install
```
Preview locally:
```sh
bundle exec jekyll serve
```
## ZeroNet
To deploy to [ZeroNet], just add a new config file, e.g. `_zeronet.yml`, to override the `site.url` variable:
```yaml
url: /YOUR_ZERONET_SITE_ADDRESS
```
Then build the site with:
```sh
bundle exec jekyll build --config _config.yml,_zeronet.yml -d PATH_TO_ZERONET/data/YOUR_ZERONET_SITE_ADDRESS
```
Afterwards you can sign and publish your zeronet site:
```sh
zeronet.py siteSign YOUR_ZERONET_SITE_ADDRESS
zeronet.py sitePublish YOUR_ZERONET_SITE_ADDRESS
```
You can also sign and publish your site via the zero panel in the browser.
[ZeroNet]: https://zeronet.io/
## Examples
- [this site itself](https://mmap.page/micro-gh-page/)
- [mmap.page](https://mmap.page)
- [add your site](https://github.com/weakish/micro-gh-page/pulls)