{"id":13512357,"url":"https://github.com/jekyll/minima","last_synced_at":"2025-09-09T20:21:21.563Z","repository":{"id":38373110,"uuid":"59331395","full_name":"jekyll/minima","owner":"jekyll","description":"Minima is a one-size-fits-all Jekyll theme for writers.","archived":false,"fork":false,"pushed_at":"2025-05-02T15:01:02.000Z","size":1257,"stargazers_count":3634,"open_issues_count":32,"forks_count":3759,"subscribers_count":62,"default_branch":"master","last_synced_at":"2025-05-05T20:29:00.409Z","etag":null,"topics":["jekyll","jekyll-theme","jekyll-themes"],"latest_commit_sha":null,"homepage":"https://jekyll.github.io/minima/","language":"SCSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jekyll.png","metadata":{"files":{"readme":"README.md","changelog":"History.markdown","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-05-20T23:07:56.000Z","updated_at":"2025-05-05T05:44:38.000Z","dependencies_parsed_at":"2023-12-12T05:04:29.782Z","dependency_job_id":"8a634abc-08e7-4d7a-967a-d1a3a84cc90b","html_url":"https://github.com/jekyll/minima","commit_stats":{"total_commits":408,"total_committers":89,"mean_commits":4.584269662921348,"dds":0.7107843137254901,"last_synced_commit":"1d5286cf9a1aae34078420d183d560dd673d98b5"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fminima","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fminima/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fminima/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jekyll%2Fminima/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jekyll","download_url":"https://codeload.github.com/jekyll/minima/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253929229,"owners_count":21985799,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jekyll","jekyll-theme","jekyll-themes"],"created_at":"2024-08-01T03:01:46.669Z","updated_at":"2025-05-13T10:53:02.805Z","avatar_url":"https://github.com/jekyll.png","language":"SCSS","funding_links":[],"categories":["SCSS","Official Themes","Writing Blog Posts With Microsoft Word","运营"],"sub_categories":["Intro / Disclaimer","Optional Inputs","内容与文档"],"readme":"\u003e [!WARNING]\n\u003e **The `master` branch is under active development towards a semver-major release with non-backwards-compatible changes.**\n\u003e \n\u003e While you may use this theme in the current state either via the `jekyll-remote-theme` plugin or via a Gemfile, it is\n\u003e recommended to point to a particular git ref that does not break your site's existing render and gradually update to a\n\u003e newer git ref via a pull request after consulting this repository's commit-log and README.\n\u003e\n\u003e **Pointing directly to the `HEAD` commit of the `master` branch is risky and may contain changes that break your site.** \n\u003e\n\u003e Example of pointing to a particular git ref via `jekyll-remote-theme` plugin:\n\u003e ```yaml\n\u003e # _config.yml\n\u003e\n\u003e remote_theme: \"jekyll/minima@1e8a445\"\n\u003e ```\n\u003e Example of pointing to a particular git ref via `Gemfile` (with `theme: minima` in `_config.yml`)\n\u003e ```ruby\n\u003e # Gemfile\n\u003e\n\u003e gem \"minima\", github: \"jekyll/minima\", ref: \"1e8a445\"\n\u003e ```\n\n\u003cbr/\u003e\u003cbr/\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\u003cem\u003e\u003cstrong\u003eDisclaimer:\u003c/strong\u003e The information here may vary depending on the version you're using.\u003cbr/\u003e\n  Please refer to the \u003ccode\u003eREADME.md\u003c/code\u003e bundled within the theme-gem for information specific to your version or by pointing\n  your browser to the Git tag corresponding to your version. e.g. https://github.com/jekyll/minima/blob/v2.5.0/README.md.\u003cbr/\u003e\n  Running \u003ccode\u003ebundle show minima\u003c/code\u003e will provide you with the local path to your current theme version.\u003c/em\u003e\u003c/p\u003e\n  \u003cimg src=\"/readme_banner.svg\"/\u003e\n  \u003cp\u003eIt's Jekyll's default (and first) theme. It's what you get when you run \u003ccode\u003ejekyll new\u003c/code\u003e.\u003c/p\u003e\n  \u003cp\u003e\u003ca href=\"https://jekyll.github.io/minima/\"\u003eTheme preview\u003c/a\u003e\u003c/p\u003e\n  \u003cp\u003e\u003cimg src=\"/screenshot.png\"/\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Installation\n\nAdd this line to your Jekyll site's Gemfile:\n\n```ruby\ngem \"minima\"\n```\n\nAnd then execute:\n\n    $ bundle\n\n\n## Contents At-A-Glance\n\nMinima 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.\n\n### Layouts\n\nRefers to files within the `_layouts` directory, that define the markup for your theme.\n\n  - `base.html` \u0026mdash; The base layout that lays the foundation for subsequent layouts. The derived layouts inject their\n    contents into this file at the line that says ` {{ content }} ` and are linked to this file via\n    [FrontMatter](https://jekyllrb.com/docs/frontmatter/) declaration `layout: base`.\n  - `home.html` \u0026mdash; The layout for your landing-page / home-page / index-page. [[More Info.](#home-layout)]\n  - `page.html` \u0026mdash; The layout for your documents that contain FrontMatter, but are not posts.\n  - `post.html` \u0026mdash; The layout for your posts.\n\n#### Base Layout\n\nFrom Minima v3 onwards, the base layout is named **`base.html`** instead of `default.html` to avoid confusing new users into\nassuming that name holds special status.\n\nUsers migrating from older versions with customized `_layouts/default.html` are advised to rename their copy to\n`_layouts/base.html`. Migrating users with additional customized layouts may either update front matter references to former\n`default.html` layout or create a new `default.html` layout referencing the current `base.html`, whichever route being the\neasiest:\n\n```\n---\n# new `_layouts/default.html` for backwards-compatibility when multiple\n# layouts have been customized.\n\nlayout: base\n---\n\n{{ content }}\n```\n\n#### Home Layout\n\n`home.html` is a flexible HTML layout for the site's landing-page / home-page / index-page. \u003cbr/\u003e\n\n##### *Main Heading and Content-injection*\n\nFrom Minima v2.2 onwards, the *home* layout will inject all content from your `index.md` / `index.html` **before** the **`Posts`** heading. This will allow you to include non-posts related content to be published on the landing page under a dedicated heading. *We recommended that you title this section with a Heading2 (`##`)*.\n\nUsually the `site.title` itself would suffice as the implicit 'main-title' for a landing-page. But, if your landing-page would like a heading to be explicitly displayed, then simply define a `title` variable in the document's front matter and it will be rendered with an `\u003ch1\u003e` tag.\n\n##### *Post Listing*\n\nThis section is optional from Minima v2.2 onwards.\u003cbr/\u003e\nIt will be automatically included only when your site contains one or more valid posts or drafts (if the site is configured to `show_drafts`).\n\nThe title for this section is `Posts` by default and rendered with an `\u003ch2\u003e` tag. You can customize this heading by defining a `list_title` variable in the document's front matter.\n\n\n### Includes\n\nRefers 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.\n\n  - `comments.html` \u0026mdash; Markup to render comments (via Disqus; active only when Jekyll environment is set to `production`).\n  - `footer.html` \u0026mdash; Defines the site's footer section.\n  - `google-analytics.html` \u0026mdash; Inserts Google Analytics module (active only in production environment).\n  - `head.html` \u0026mdash; Code-block that defines the `\u003chead\u003e\u003c/head\u003e` in *default* layout.\n  - `custom-head.html` \u0026mdash; Placeholder to allow users to add more metadata to `\u003chead /\u003e`.\n  - `header.html` \u0026mdash; Defines the site's main header section that consists of the site's *title* and *navigation*.\n  - `nav-items.html` \u0026mdash; Contains the logic and markup to render individual link items for the site's navigation.\n  - `social.html` \u0026mdash; Renders social-media icons based on the `minima:social_links` data in the config file using\n    the latest version of Font Awesome Free webfonts via remote CDN.\n  - `sub-footer.html` \u0026mdash; Placeholder to allow inserting markup (e.g. deferred scripts) before the `\u003c/body\u003e` tag.\n\n\n### Sass\n\nRefers to `.scss` files within the `_sass` directory that define the theme's styles.\n\n  - `minima/skins/classic.scss` \u0026mdash; The \"classic\" skin of the theme. *Used by default.*\n  - `minima/initialize.scss` \u0026mdash; A component that defines the theme's *skin-agnostic* variable defaults and sass partials.\n    It imports the following components (in the following order):\n    - `minima/custom-variables.scss` \u0026mdash; A hook that allows overriding variable defaults and mixins. (*Note: Cannot override styles*)\n    - `minima/_base.scss` \u0026mdash; Sass partial for resets and defines base styles for various HTML elements.\n    - `minima/_layout.scss` \u0026mdash; Sass partial that defines the visual style for various layouts.\n    - `minima/custom-styles.scss` \u0026mdash; A hook that allows overriding styles defined above. (*Note: Cannot override variables*)\n\nRefer the [skins](#skins) section for more details.\n\n\n### Assets\n\nRefers to various asset files within the `assets` directory.\n\n  - `assets/css/style.scss` \u0026mdash; Imports sass files from within the `_sass` directory and gets processed into the theme's\n    stylesheet: `assets/css/styles.css`.\n  - `assets/minima-social-icons.html` \u0026mdash; Imports enabled social-media icon graphic and gets processed into a composite SVG file.\n    Refer [section on social networks](#social-networks) for its usage.\n\n\n### Plugins\n\nMinima 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.\n\n\n## Usage\n\nHave the following line in your config file:\n\n```yaml\ntheme: minima\n```\n\n\n### Customizing templates\n\nTo 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.\ne.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 `\u003cyoursite\u003e/_includes` and start editing that file.\n\nThe site's default CSS has now moved to a new place within the gem itself, [`assets/css/style.scss`](assets/css/style.scss).\n\nIn Minima 3.0, if you only need to customize the colors of the theme, refer to the subsequent section on skins. To have your\n*CSS overrides* in sync with upstream changes released in future versions, you can collect all your overrides for the Sass\nvariables and mixins inside a sass file placed at `_sass/minima/custom-variables.scss` and all other overrides inside a sass file\nplaced at path `_sass/minima/custom-styles.scss`.\n\nYou need not maintain entire partial(s) at the site's source just to override a few styles. However, your stylesheet's primary\nsource (`assets/css/style.scss`) should contain the following:\n\n  - Front matter dashes at the very beginning (can be empty).\n  - Directive to import a skin.\n  - Directive to import the base styles (automatically loads overrides when available).\n\nTherefore, your `assets/css/style.scss` should contain the following at minimum:\n\n```sass\n---\n---\n\n@import\n  \"minima/skins/{{ site.minima.skin | default: 'classic' }}\",\n  \"minima/initialize\";\n```\n\n#### Skins\n\nMinima 3.0 supports defining and switching between multiple color-palettes (or *skins*).\n\n```\n.\n├── minima.scss\n└── minima\n    └── _syntax-highlighting.scss\n```\n\n\nA skin is a Sass file placed in the directory `_sass/minima/skins` and it defines the variable defaults related to the \"color\"\naspect of the theme. It also embeds the Sass rules related to syntax-highlighting since that is primarily related to color and\nhas to be adjusted in harmony with the current skin.\n\nThe default color palette for Minima is defined within `_sass/minima/skins/classic.scss`. To switch to another available skin,\nsimply declare it in the site's config file. For example, to activate `_sass/minima/skins/dark.scss` as the skin, the setting\nwould be:\n\n```yaml\nminima:\n  skin: dark\n```\n\nAs part of the migration to support skins, some existing Sass variables have been retired and some **have been redefined** as\nsummarized in the following table:\n\nMinima 2.0      | Minima 3.0\n--------------- | ----------\n`$brand-color`  | `$link-base-color`\n`$grey-*`       | `$brand-*`\n`$orange-color` | *has been removed*\n\n##### Available skins\n\nSkin setting    | Description\n--------------- | -----------\nclassic         | Default, light color scheme.\ndark            | Dark variant of the classic skin.\nauto            | *Adaptive skin* based on the default classic and dark skins.\nsolarized       | *Adaptive skin* for [solarized](https://github.com/solarized) color scheme skins.\nsolarized-light | Light variant of solarized color scheme.\nsolarized-dark  | Dark variant of solarized color scheme.\n\n*:bulb: Adaptive skins switch between the \"light\" and \"dark\" variants based on the user's operating system setting or browser setting\n(via CSS Media Query [prefers-color-scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme)).*\n\n### Customize navigation links\n\nThis allows you to set which pages you want to appear in the navigation area and configure order of the links.\n\nFor instance, to only link to the `about` and the `portfolio` page, add the following to your `_config.yml`:\n\n```yaml\nminima:\n  nav_pages:\n    - about.md\n    - portfolio.md\n```\n\u003e [!WARNING]\n\u003e Please note that **`site.header_pages`** is **`site.minima.nav_pages`** in Minima 3.0\n\n\n### Change default date format\n\nYou can change the default date format by specifying `site.minima.date_format`\nin `_config.yml`.\n\n```\n# Minima date format\n# refer to http://shopify.github.io/liquid/filters/date/ if you want to customize this\nminima:\n  date_format: \"%b %-d, %Y\"\n```\n\n\n### Extending the `\u003chead /\u003e`\n\nYou can *add* custom metadata to the `\u003chead /\u003e` of your layouts by creating a file `_includes/custom-head.html` in your source directory. For example, to add favicons:\n\n1. Head over to [https://realfavicongenerator.net/](https://realfavicongenerator.net/) to add your own favicons.\n2. [Customize](#customization) default `_includes/custom-head.html` in your source directory and insert the given code snippet.\n\n\n### Enabling comments (via Disqus)\n\nOptionally, if you have a Disqus account, you can render a comments section below each post with the following configuration:\n\n```yaml\nurl: \"https://my_domain.com\"\ndisqus:\n  shortname: my_disqus_shortname\n```\n\nYou can find out more about Disqus' shortnames [here](https://help.disqus.com/installation/whats-a-shortname).\n\nComments are enabled by default and will only appear in production, i.e., `JEKYLL_ENV=production`\n\nIf you don't want to display comments for a particular post you can disable them by adding `comments: false` to that\npost's YAML Front Matter.\n\n### Author Metadata\n\nFrom `Minima-3.0` onwards, `site.author` is expected to be a mapping of attributes instead of a simple scalar value:\n\n```yaml\nauthor:\n  name: John Smith\n  email: \"john.smith@foobar.com\"\n```\n\nTo migrate existing metadata, update your config file and any reference to the object in your layouts and includes as summarized below:\n\nMinima 2.x    | Minima 3.0\n------------- | -------------------\n`site.author` | `site.author.name`\n`site.email`  | `site.author.email`\n\n\n### Social networks\n\nYou can add links to the accounts you have on other sites, with respective icon as an SVG graphic, via the config file.\nFrom `Minima-3.0` onwards, the social media data is sourced from config key `minima.social_links`. It is a list of key-value pairs, each entry\ncorresponding to a link rendered in the footer. For example, to render links to Jekyll GitHub repository and Twitter account (now X), one\nshould have:\n\n```yaml\nminima:\n  social_links:\n    - title: Jekyll repository at GitHub\n      icon: github\n      url: \"https://github.com/jekyll/jekyll\"\n    - title: Jekyll at X (formerly Twitter)\n      icon: x-twitter\n      url: \"https://x.com/jekyllrb\"\n```\n\nwhere `title` corresponds to the link-title displayed when a visitor hovers mouse-pointer over url / icon and\n`icon` refers to the Font Awesome icon id. e.g. `github` corresponds to `fa-github`.\n\nSocial platform icons are rendered using the latest version of Font Awesome Free webfonts sourced via remote CDN.\nThe full list of available social icons can be found at https://fontawesome.com/search?ic=brands\n\n\u003e [!NOTE]\n\u003e The link to your site's main syndication feed is always rendered as the last item of the social-links list.\u003cbr /\u003e\n\u003e You may opt to not have this link rendered at all by setting config **`minima.hide_site_feed_link`** to `true`:\n\u003e ```yaml\n\u003e minima:\n\u003e   hide_site_feed_link: true  # `false` or `null` by default\n\u003e ```\n\n### Enabling Google Analytics\n\nTo enable Google Analytics, add the following lines to your Jekyll site:\n\n```yaml\ngoogle_analytics: G-NNNNNNNNNN  // The former `UA-NNNNNNNN-N` format is no longer supported by Google\n```\n\nGoogle Analytics will only appear in production, i.e., `JEKYLL_ENV=production`.\n\n### Enabling Excerpts on the Home Page\n\nTo display post-excerpts on the Home Page, simply set `show_excerpts` under top-level key `minima` to `true` in your\n`_config.yml`:\n\n```yaml\nminima:\n  show_excerpts: true\n```\n\n\n## Contributing\n\nBug 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.\n\n## Development\n\nTo set up your environment to develop this theme, run `script/bootstrap`.\n\nTo 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.\n\n## License\n\nThe theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekyll%2Fminima","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjekyll%2Fminima","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjekyll%2Fminima/lists"}