Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fernandopasik/jekyll-theme-material-docs

Jekyll theme for documentation 📝 built with material web components
https://github.com/fernandopasik/jekyll-theme-material-docs

documentation github-pages github-pages-theme jekyll jekyll-theme jekyll-themes material-design

Last synced: 3 months ago
JSON representation

Jekyll theme for documentation 📝 built with material web components

Host: GitHub
URL: https://github.com/fernandopasik/jekyll-theme-material-docs
Owner: fernandopasik
License: mit
Created: 2020-07-30T20:48:17.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-09-24T09:05:46.000Z (3 months ago)
Last Synced: 2024-09-29T03:05:20.812Z (3 months ago)
Topics: documentation, github-pages, github-pages-theme, jekyll, jekyll-theme, jekyll-themes, material-design
Language: HTML
Homepage: https://fernandopasik.com/jekyll-theme-material-docs/
Size: 1.43 MB
Stars: 8
Watchers: 3
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

# Material Docs

Jekyll theme for documentation 📝 built with material web components

[![Build Status](https://github.com/fernandopasik/jekyll-theme-material-docs/actions/workflows/main.yml/badge.svg)](https://github.com/fernandopasik/jekyll-theme-material-docs/actions/workflows/main.yml 'Build Status')
[![Known Vulnerabilities](https://snyk.io/test/github/fernandopasik/jekyll-theme-material-docs/badge.svg?targetFile=package.json)](https://snyk.io/test/github/fernandopasik/jekyll-theme-material-docs?targetFile=package.json 'Known Vulnerabilities')

[![ruby gem version](https://img.shields.io/gem/v/jekyll-theme-material-docs?logo=rubygems)](https://rubygems.org/gems/jekyll-theme-material-docs 'ruby gem version')

## Installation

### Via remote theme

Add this line to your Jekyll site's `_config.yml`:

```yaml
remote_theme: fernandopasik/jekyll-theme-material-docs

plugins:
- jekyll-remote-theme
```

### Via gems

Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "jekyll-theme-material-docs"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: jekyll-theme-material-docs
```

And then execute:

```bash
bundle
```

Or install it yourself as:

```bash
gem install jekyll-theme-material-docs
```

## License