Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrinjamul/simple-jekyll
Simple is simpliest jekyll theme. Just turn markdown into website. Highly customizable.
https://github.com/mrinjamul/simple-jekyll
jekyll jekyll-site jekyll-theme site-generator
Last synced: 3 months ago
JSON representation
Simple is simpliest jekyll theme. Just turn markdown into website. Highly customizable.
- Host: GitHub
- URL: https://github.com/mrinjamul/simple-jekyll
- Owner: mrinjamul
- License: mit
- Created: 2021-06-08T15:50:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-18T06:41:01.000Z (8 months ago)
- Last Synced: 2024-10-02T09:27:06.697Z (3 months ago)
- Topics: jekyll, jekyll-site, jekyll-theme, site-generator
- Language: SCSS
- Homepage: http://mrinjamul.is-a.dev/simple-jekyll
- Size: 55.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# simple-jekyll
Simple is simpliest jekyll theme.
- turn markdown into website
- Highly customizable
## Contents
- [Usage](#usage)
- [Development](#development)
- [Author](#author)
- [License](#license)
## Usage
### 1. Install dependencies
`Simple` is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem and related dependencies:
```bash
bundle install
```
### Quick start
To help anyone with any level of familiarity with Jekyll quickly get started, `Simple` includes everything you need for a basic Jekyll site. To that end, just clone Simple and start up Jekyll.
```bash
git clone https://github.com/mrinjamul/simple-jekyll.git
```
### 3. Running locally
To see your Jekyll site with `Simple` applied, start a Jekyll server. In Terminal:
```bash
cd simple-jekyll
./tools/run
```
Open in your browser, and voilà.
### 4. Serving it up
If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project.
1. Fork this repo and switch to the `gh-pages` branch.
1. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain.
1. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/simple`, use `http://username.github.io/simple/`. **Be sure to include the trailing slash.**
1. Done! Head to your GitHub Pages URL or custom domain.
No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site.
## Development
Simple has two branches, but only one is used for active development.
- `main` for development. **All pull requests should be to submitted against `master`.**
- `gh-pages` for our hosted site. **Please avoid using this branch.**
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in `_sass/`, included into `styles.scss`, and compile to `styles.css`.
## Author
- **Injamul Mohammad Mollah**
## License
Open sourced under the [MIT license](LICENSE).
## Want to contribute?
Feel free to contribute.
Read [guideline](CONTRIBUTING.md) and start contributing.
Have questions or suggestions? Feel free to [email](mailto:[email protected]) us.