当前位置: 首页 > 软件库 > Web应用开发 > >

jekyll-readme-index

授权协议 MIT License
开发语言 JavaScript
所属分类 Web应用开发
软件类型 开源软件
地区 不详
投 递 者 劳仲渊
操作系统 未知
开源组织
适用人群 未知
 软件概览

Jekyll Readme Index

A Jekyll plugin to render a project's README as the site's index.

What it does

Let's say you have a GitHub repository with a README.md file, that you'd like to use as the index (main page) for a GitHub Pages site. You could rename the file to index.md, but then it wouldn't render on GitHub.com. You could add YAML front matter with permalink: / to the README, but why force a human to do what Jekyll can automate?

If you have a readme file, and your site doesn't otherwise have an index file, this plugin instructs Jekyll to use the readme as the site's index. That's it. No more, no less.

Usage

  1. Add the following to your Gemfile
gem "jekyll-readme-index"
  1. Add the follow to your site's config
plugins:
  - jekyll-readme-index

Note: If you are using a Jekyll version less than 3.5.0, use the gems key instead of plugins.

Configuration

Configuration options are optional are placed in _config.yml under the readme_index key. They default to:

readme_index:
  enabled:          true
  remove_originals: false
  with_frontmatter: false

Removing originals

By default the original README markdown files will be included as static pages in the output. To remove them from the output, set the remove_originals key to true.

Disabling

Even if the plugin is enabled (e.g., via the :jekyll_plugins group in your Gemfile) you can disable it by setting the enabled key to false.

  • 完整版请参考: https://mazhaoxin.github.io/2018/08/04/Create_Free_Static_Blog_Base_On_Jekyll/ http://483v7j.coding-pages.com/2018/08/04/Create_Free_Static_Blog_Base_On_Jekyll/ 这篇算是交作业了。 写在前面的话 无意中在知乎看到了一个关于支

  • 乐在分享 Jekyll本地搭建开发环境以及Github部署流程 前言 博客从wordpres迁移到Jekyll上来了,整个过程还是很顺利的。Jekyll是什么?它是一个简单静态博客生成工具,为什么是静态,因为它是不需要数据库的,通过markdown编写静态文件,生成Html页面,它的优点是提升了页面的响应速度,并且让博主可以只专注于写文章,不用再去考虑如何排版(markdown语法很好的解决了排版

  • categories: [Frontend] tags: Frontend HTML 写在前面 最近发现一个问题, 博客数量越来越多了, 都放在_posts下实在是有点不方便, 于是想着分个类, Google 了一圈, 找到了一篇不错的博客, 如下: Jekyll个人博客添加分类Category功能; 于是就跟着这个教程走了, 中途也发现一些问题, 因为我的 Jekyll 不是完全本地配置的, 还

  • 折腾了几天,将sbdn上的文章转移到gayhub pages上,做个简要笔记,转移到gayhub pages,新地址戳这里,废话不多说,直接开始 gayhub部分 创建gayhub帐号,然后新建一个名为用户名.github.io的存储库,注意,存储库的名称一定要是这个形式的,否则后期访问处理路径问题是很麻烦的 向存储出中添加一个index.html或者README.md 进入settings,往下

  • 你必须要懂一点git和网页开发。 安装了 git ,并且有 github 账户。 github设计了 Pages功能 ,允许用户自定义项目首页 github提供模板,允许 站内生成 网页,但也允许用户自己编写网页,然后上传。有意思的是,这种上传并不是单纯的上传,而是 会经过Jekyll程序的再处理 。 Jekyll (发音/'dʒiːk əl/,"杰克尔")是一个静态站点生成器,它会根据网页源码生

  • output linux fedora 24 jekyll 搭建 github blog input 需要 github 帐号 baidu jekyll github http://www.ruanyifeng.com/blog/2012/08/blogging_with_jekyll.html markdown syntax https://daringfireball.net/projects

 相关资料
  • 主要记录 GitBook 的安装配置以及一些插件信息,当前使用的 GitBook 版本为 3.2.3。 推荐一下 docsify,相当于一个精简的 GitBook,不需要编译,使用很方便。这里 基于 doscify 做了一些修改,具体的效果可以看一下 在线的示例 . 运行 安装 GitBook npm install gitbook-cli -g Clone 代码到本地并运行 git clone

  • 为什么要有插件 为了解耦 BetterScroll 1.x 的各个 feature 的功能,防止 bundle 体积无限制的增加。在 2.x 的架构设计当中,采用了『插件化』 的架构设计。对于 1.x 的各个 feature,在 2.x 都将以 Plugin 的形式实现。 已有的插件: pulldown pullup scrollbar slide wheel zoom mouse-wheel o

  • 简介 这类题目思路比较简单直白,按照问题的描述,把解题的步骤一步一步直白的翻译成代码,就行了。这类题目主要考察写代码是否熟练,是否具备基本的调试能力,编程风格是否良好等。

  • 图节点定义 无向图的节点定义如下: // 无向图的节点 class UndirectedGraphNode { int label; ArrayList<UndirectedGraphNode> neighbors; UndirectedGraphNode(int x) { label = x;} }; // 无向图的节点 struct UndirectedGraphNo

  • 简介 当题目看不出任何规律,既不能用分治,贪心,也不能用动规时,这时候万能方法——搜索, 就派上用场了。搜索分为广搜和深搜,广搜里面又有普通广搜,双向广搜,A*搜索等。 深搜里面又有普通深搜,回溯法等。 广搜和深搜非常类似(除了在扩展节点这部分不一样),二者有相同的框架,如何表示状态? 如何扩展状态?如何判重?尤其是判重,解决了这个问题,基本上整个问题就解决了。

  • 项目概述 产品名称:LaraBBS 项目代号:larabbs 官方地址:分享:Laravel 教程系列书第二本《Web 开发实战进阶 - 从零开始构建论坛系... LaraBBS 是一个简洁的论坛应用,使用 Laravel5.5 编写而成。一步步开发此项目的教程请见 《Web 开发实战进阶 - 从零开始构建论坛系统》。 功能如下 用户认证 —— 注册、登录、退出; 个人中心 —— 用户个人中心,编