arthurh/web-md-generator

轻松从Markdown文件创建静态网站

维护者

详细信息

github.com/ArthurHlt/web-md-generator

源代码

问题

安装: 23

依赖项: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 0

语言：JavaScript

1.2 2014-07-02 22:54 UTC

Requires

MIT ef9721be5d9ec3bb6c65fc99d3c6a14c69ce054c

generatormarkdownstaticwebsitemarkdown generator

This package is auto-updated.

Last update: 2024-09-12 21:27:12 UTC

README

轻松从Markdown文件创建静态网站。

这是什么？

这是一个静态网站生成器。它会将您文件夹中的所有Markdown文件提取出来，并生成一个真正的网站（归功于jr）。它还会直接使用您的Markdown文件创建一个简单的菜单。

用法

最佳方式是从这里获取phar存档：web-md-generator.phar。

将此存档放在您的未来网站中，其中包含所有Markdown文件（Markdown文件应具有.md扩展名）。最后运行

php web-md-generator.phar

之后，您可以简单地添加其他Markdown文件并重新生成以将其添加到菜单中。您还可以简单地修改生成的.html文件，因为它仍然是Markdown，所以修改起来很简单。更改您的option.yml

当您生成网站时，将创建一个新的options.yml文件。默认情况下，您将拥有以下内容：

styles:
  - "default"
  - "//fonts.googleapis.com/css?family=Average"
  - "//fonts.googleapis.com/css?family=Roboto:400,700"
charset: "UTF-8"
title: "My Website"
menuPosition: "top"
index: index
scripts:
  - "js/showdown.js"

styles：您可以通过将default更改为bootstrap来获取Twitter风格的Bootstrap，并添加所有您想要的CSS。

title：通过您的网站名称更改标题。

menuPosition：通过将top或side更改来将菜单放在顶部或侧面（仅适用于default样式）。

index：设置用作index.html的Markdown文件（不要使用md扩展名）。

scripts：添加您想要的全部JavaScript文件（默认情况下会加载jQuery）。

最后，再次运行php web-md-generator.phar以重新生成您的网站。

获取标志和favicon

对于favicon：只需在您的根网站文件夹中添加一个favicon.(png|ico|jpg|gif)文件，然后重新生成您的网站。

对于标志：只需在您的根网站文件夹中添加一个logo.(png|ico|jpg|gif)文件，然后重新生成您的网站。

自定义菜单

当您生成网站时，将有一个menu.yml文件，您可以修改它来设置链接和/或菜单名称。

menu:
    - { index: 'read me' } #on the left file without .html extension and on the right your menu name
    - { 'who am i': 'who am i' }

示例和演示

对于示例，请访问：https://github.com/ArthurHlt/web-md-generator-example

顶部菜单的默认样式演示：http://web-md-generator.arthurh.fr/default-top/

侧面菜单的默认样式演示：http://web-md-generator.arthurh.fr/default-side/

Bootstrap样式的演示：http://web-md-generator.arthurh.fr/bootstrap/