Minima_is_a_one-size-fits-all_Jekyll_theme_for_wri

共40个文件

html：12个

md：8个

scss：5个

需积分: 5 194 浏览量 2024-08-25 13:14:09 上传评论收藏 153KB ZIP 举报

资源推荐

资源详情

资源评论

收起资源包目录

Minima_is_a_one-size-fits-all_Jekyll_theme_for_wri_minima.zip （40个子文件）

DataXujing-minima-affcd93

.editorconfig 208B

_posts

2016-05-20-my-example-post.md 787B

2016-05-20-welcome-to-jekyll.md 1KB

2016-05-20-super-long-article.md 2KB

2016-05-20-this-post-demonstrates-post-content-styles.md 5KB

.travis.yml 101B

_config.yml 801B

assets

main.scss 96B

LICENSE.txt 1KB

_sass

minima

_layout.scss 4KB

_syntax-highlighting.scss 3KB

_base.scss 3KB

minima.scss 1KB

_includes

google-analytics.html 432B

header.html 2KB

icon-twitter.svg 814B

icon-github.html 177B

icon-github.svg 953B

disqus_comments.html 705B

icon-twitter.html 180B

head.html 504B

footer.html 1KB

screenshot.png 127KB

_layouts

post.html 840B

page.html 218B

home.html 598B

default.html 331B

404.html 398B

CODE_OF_CONDUCT.md 3KB

Gemfile 38B

History.markdown 3KB

about.md 524B

.gitignore 45B

script

cibuild 214B

bootstrap 54B

build 80B

server 36B

index.md 218B

README.md 7KB

minima.gemspec 839B

# minima *Minima is a one-size-fits-all Jekyll theme for writers*. It's Jekyll's default (and first) theme. It's what you get when you run `jekyll new`. [Theme preview](https://jekyll.github.io/minima/) ![minima theme preview](/screenshot.png) ## Installation Add this line to your Jekyll site's Gemfile: ```ruby gem "minima" ``` And add this line to your Jekyll site: ```yaml theme: minima ``` And then execute: $ bundle ## Contents At-A-Glance Minima has been scaffolded by the `jekyll new-theme` command and therefore has all the necessary files and directories to have a new Jekyll site up and running with zero-configuration. ### Layouts Refers to files within the `_layouts` directory, that define the markup for your theme. - `default.html` — The base layout that lays the foundation for subsequent layouts. The derived layouts inject their contents into this file at the line that says ` {{ content }} ` and are linked to this file via [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: default`. - `home.html` — The layout for your landing-page / home-page / index-page. - `page.html` — The layout for your documents that contain FrontMatter, but are not posts. - `post.html` — The layout for your posts. ### Includes Refers to snippets of code within the `_includes` directory that can be inserted in multiple layouts (and another include-file as well) within the same theme-gem. - `disqus_comments.html` — Code to markup disqus comment box. - `footer.html` — Defines the site's footer section. - `google-analytics.html` — Inserts Google Analytics module (active only in production environment). - `head.html` — Code-block that defines the `<head></head>` in *default* layout. - `header.html` — Defines the site's main header section. By default, pages with a defined `title` attribute will have links displayed here. - `icon-* files` — Inserts github and twitter ids with respective icons. ### Sass Refers to `.scss` files within the `_sass` directory that define the theme's styles. - `minima.scss` — The core file imported by preprocessed `main.scss`, it defines the variable defaults for the theme and also further imports sass partials to supplement itself. - `minima/_base.scss` — Resets and defines base styles for various HTML elements. - `minima/_layout.scss` — Defines the visual style for various layouts. - `minima/_syntax-highlighting.scss` — Defines the styles for syntax-highlighting. ### Assets Refers to various asset files within the `assets` directory. Contains the `main.scss` that imports sass files from within the `_sass` directory. This `main.scss` is what gets processed into the theme's main stylesheet `main.css` called by `_layouts/default.html` via `_includes/head.html`. This directory can include sub-directories to manage assets of similar type, and will be copied over as is, to the final transformed site directory. ### Plugins Minima comes with [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin preinstalled to make sure your website gets the most useful meta tags. See [usage](https://github.com/jekyll/jekyll-seo-tag#usage) to know how to set it up. ## Usage ### Customization To override the default structure and style of minima, simply create the concerned directory at the root of your site, copy the file you wish to customize to that directory, and then edit the file. e.g., to override the [`_includes/head.html `](_includes/head.html) file to specify a custom style path, create an `_includes` directory, copy `_includes/head.html` from minima gem folder to `<yoursite>/_includes` and start editing that file. The site's default CSS has now moved to a new place within the gem itself, [`assets/main.scss`](assets/main.scss). To **override the default CSS**, the file has to exist at your site source. Do either of the following: - Create a new instance of `main.scss` at site source. - Create a new file `main.scss` at `<your-site>/assets/` - Add the frontmatter dashes, and - Add `@import "minima";`, to `<your-site>/assets/main.scss` - Add your custom CSS. - Download the file from this repo - Create a new file `main.scss` at `<your-site>/assets/` - Copy the contents at [assets/main.scss](assets/main.scss) onto the `main.scss` you just created, and edit away! - Copy directly from Minima 2.0 gem - Go to your local minima gem installation directory ( run `bundle show minima` to get the path to it ). - Copy the `assets/` folder from there into the root of `<your-site>` - Change whatever values you want, inside `<your-site>/assets/main.scss` -- ### Change default date format You can change the default date format by specifying `site.minima.date_format` in `_config.yml`. ``` # Minima date format # refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this minima: date_format: "%b %-d, %Y" ``` -- ### Enabling comments (via Disqus) Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post. To enable it, add the following lines to your Jekyll site: ```yaml disqus: shortname: my_disqus_shortname ``` You can find out more about Disqus' shortnames [here](https://help.disqus.com/customer/portal/articles/466208). Comments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production` If you don't want to display comments for a particular post you can disable them by adding `comments: false` to that post's YAML Front Matter. -- ### Enabling Google Analytics To enable Google Anaytics, add the following lines to your Jekyll site: ```yaml google_analytics: UA-NNNNNNNN-N ``` Google Analytics will only appear in production, i.e., `JEKYLL_ENV=production` ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/jekyll/minima. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## Development To set up your environment to develop this theme, run `script/bootstrap`. To test your theme, run `script/server` (or `bundle exec jekyll serve`) and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme and the contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh. ## License The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

评论收藏

内容反馈