Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/binnette/jekyll-map-theme
A jekyll-theme for simple webpage about mapping
https://github.com/binnette/jekyll-map-theme
Last synced: about 1 month ago
JSON representation
A jekyll-theme for simple webpage about mapping
- Host: GitHub
- URL: https://github.com/binnette/jekyll-map-theme
- Owner: Binnette
- License: mit
- Created: 2023-09-25T12:01:24.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-12T23:58:06.000Z (9 months ago)
- Last Synced: 2024-03-18T00:01:26.818Z (8 months ago)
- Language: HTML
- Size: 6.95 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jekyll-map-theme
Welcome to your new Jekyll theme! In this directory, you'll find the files you need to be able to package up your theme into a gem. Put your layouts in `_layouts`, your includes in `_includes`, your sass files in `_sass` and any other assets in `assets`.
To experiment with this code, add some sample content and run `bundle exec jekyll serve` – this directory is setup just like a Jekyll site!
TODO: Delete this and the text above, and describe your gem
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-map-theme"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
title: YOUR TITLE # to replace with the title of your website
description: >- # to replace with your description
I am the description of your website.
I can be on multiple lines.
github_username: YOUR_USERNAME # to replace with your github username
github_repo: YOUR_REPO # to replace with the repo name of your website using the theme
# Theme settings
theme: jekyll-map-theme
jekyll-map-theme:
# Use this parameter to change the image background
# Possible values: map-icons, rtk or camera
background_image: map-icons
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-map-theme
## Usage
TODO: Write usage instructions here. Describe your available layouts, includes, sass and/or assets.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-map-theme. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://www.contributor-covenant.org/) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-map-theme.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).