【问题标题】:Github pages cannot display markdown correctlyGithub 页面无法正确显示 markdown
【发布时间】:2016-02-15 09:29:53
【问题描述】:

我正在使用 github pages + jekyll 来建立我的博客。

在推送我的最新提交之前它工作正常。此提交添加了一个 cname 文件,并且只编辑了一些单词,而没有对我的网站架构进行任何更改。

-    <h3 class="description">aaaaaaaaaa</h3>
+    <h3 class="description">bbbbbbbbbb</h3>

之后降价没有正确显示。

当我写#head1。没有出现标题head1,只是直接出现#head1。

但是,如果我在 localhost:4000 中使用 jekyll serve build,它会正确显示。

这是我的 _config.yml:

降价:kramdown
markdown_ext:markdown,mkd,mkdn,md
Textile_ext: 纺织品
荧光笔:pygments

任何想法是什么导致了这个错误?

【问题讨论】:

    标签: github markdown jekyll github-pages


    【解决方案1】:

    更新!

    这很可能是由于GitHub Pages 上的Jekyll 3 upgrade

    从 2016 年 5 月 1 日起,GitHub 将不再支持 rdiscountredcarpet。另外,从 2 月 1 日起,GitHub Pages 只支持rouge

    从 2016 年 5 月 1 日开始,GitHub Pages 将仅支持 kramdown, Jekyll 的默认 Markdown 引擎。

    GitHub Pages 现在只支持 胭脂。

    您可以查看here

    为了处理它,请执行以下操作:

    首先,按照answer 的说明进行尝试。而不是#Heading,你会写# Heading

    第二,调整你的_config.yml:把highlightermarkdown改成

    highlighter: rouge
    markdown: kramdown
    kramdown:
      input: GFM
    

    第三,本地建站,使用Bundler,方法recommended by GitHub

    1. 安装捆绑器:

      gem install bundler
      
    2. 然后运行 ​​bundle update - 如果您已经在本地安装了此 gem,这将更新您的所有 gem,包括 github-pages

    3. 然后,创建一个Gemfile(不带任何文件扩展名),内容如下:

      source 'https://rubygems.org' 
      gem 'github-pages'
      

    将其保存到项目的根目录。

    1. 然后,在您的项目上运行 bundle install。这将创建一个名为 Gemfile.lock 的文件,并将安装所有必需的 gem 及其依赖项

    2. 最后,运行bundle exec jekyll serve --watch,您将能够在本地查看您的网站,就像您在线查看时一样(在 GitHub 上托管时)。

    到时候你应该没事了!


    附言。如果您的项目需要更多 gem,例如 jekyll-paginatejekyll-mentions,您需要将它们添加到 Gemfile,例如:

    source 'https://rubygems.org' 
    gem 'github-pages'
    gem 'jekyll-paginate'
    

    另外,将它们添加到您项目的_config.yml

    gems:
      - jekyll-paginate
      - jekyll-mentions
    

    您将在此处看到gem versions currently supported by GitHub Pages 的列表。在这里你读到了Upgrading Jekyll 2 to 3

    希望有所帮助!

    【讨论】:

    • 感谢您的回答。在第一步中,我在 # 和标题标题之间添加了一个空格作为您的描述。我编辑了我的 config.yml。但是,它仍然不起作用。我不完全理解你的第三步,只是更新我的 jekyll 使用 gem update jekyll。 (现在是 jekyll 版本 3.1.1)。在 localhost 4000 中,它仍然有效。我发现除了markdown文件中的######之类的标题标记之外,一切都很好。
    • 我将编辑答案以使您更清楚。 :)
    • @lululu 抱歉耽搁了,我之前没时间做这件事。但现在我相信答案是完整的。让我知道进展如何,好吗?
    • 哦,我忘了说:当你说你运行gem update jekyll 并且没有工作时,发生这种情况是因为 jekyll 不是唯一需要更新的 gem。 github-pages gem 是这个案例中最重要的。此外,当您在项目中运行 bundle install 时,它将需要 GH Pages 当前使用的相同 jekyll 版本(现在是 Jekyll 3.0.3)。不时更新你所有的 gem 很重要,这样你就不会遇到麻烦:运行bundle update
    • 很抱歉我耽误了一个星期。我在我的 mac osx 中遇到了 ruby​​ 的问题。幸运的是,我解决了这个问题。之后,我在 github 中删除了我的博客存储库并重新创建它。然后,我绝对遵守了您的回答和有关 github 页面的文档说明中的步骤,以重新建立我的博客。有用!!!虽然我还没有找到这个问题的确切原因,但我会试着弄清楚。非常感谢,您的回答对我很有帮助。我会采用它。
    【解决方案2】:

    运行我自己的 Jekyll 驱动的 github pages 博客的一点观察,

    表示标题大小的 # 和标题文本之间的空格很重要,否则降价将不会按预期显示。因此,在您的示例中,我会将我的降价标题显示为,

    # Zookeeper Atomic Broadcast for heading 1
    
    ## Zookeeper Atomic Broadcast for heading 2
    
    ### Zookeeper Atomic Broadcast for heading 3
    
    #### Zookeeper Atomic Broadcast for heading 4
    
    ##### Zookeeper Atomic Broadcast for heading 5
    

    【讨论】:

      【解决方案3】:

      GitHub 支持 markdown 以及 jekyll。
      首先用 .md 扩展名重命名您的文件

      如果您的文件夹中有.nojekyll,它将禁用 njekyll。

      确认您没有此文件夹。


      阅读docs && GitHub relevant doc,了解如何准备和部署


      运行 Jekyll

      使用命令 git checkout 切换到 GitHub Pages 构建服务器用于生成站点的默认分支。您切换到的默认分支取决于您正在构建的 GitHub Pages 站点的类型。

      对于 Project Pages 网站,切换到 gh-pages。 对于用户页面或组织页面站点,切换到主站点。有关详细信息,请参阅“用户、组织和项目页面”。

      在存储库的根目录中使用命令 bundle exec jekyll serve 来使用 Bundler 运行 GitHub Pages 构建服务器。

      bundle exec jekyll serve 导航至http://localhost:4000 以查看您的本地站点。

      【讨论】:

      • 感谢您回答我的问题。所有文件都以md 扩展名结尾,我确定我的文件夹中没有.nojekyll。它仍然不起作用。我打算仔细阅读所有关于 github pages 和 jekyll 的文档。
      • 酷,我会尽力帮助你
      猜你喜欢
      • 2020-08-22
      • 2021-01-19
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2021-10-06
      • 2011-03-31
      • 2018-03-19
      相关资源
      最近更新 更多