我遇到了 Docsify ( https://docsify.js.org/#/ ),并且在尝试它时玩得很开心。我有兴趣使用我自己的烧瓶服务器而不是 Github Pages 或节点来提供一些文档,但是我不知道如何实现它。
正如 Docsify ( https://docsify.js.org/#/quickstart?id=manual-initialization ) 所描述的那样,在本地提供一个简单index.html
的渲染并且README.md
作为降价内容工作得很好。
index.html
<!-- index.html -->
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="UTF-8">
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
//...
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</body>
</html>
README.md
# Hi, I'm markdown content
运行静态服务器的命令行(有效):
python -m SimpleHTTPServer 3000
现在,在 Flask 中,我使用的是应用工厂 + 蓝图模式,就 Flask 而言,一切都按预期工作。我可以添加一个新的端点,它渲染得很好。我的文件结构:
├── instance
│ └── flask.cfg
├── main.py
├── project
│ ├── __init__.py
│ ├── front
│ │ ├── __init__.py
│ │ ├── routes.py
│ │ └── templates
│ │ └── front
│ │ └── index.html
│ ├── documentation
│ │ ├── __init__.py
│ │ ├── routes.py
│ │ └── templates
│ │ └── documentation
│ │ ├── README.md
│ │ └── index.html
│ ├── static
│ │ ├── favicon.ico
│ │ └── style.css
│ └── templates
│ └── base.html
└── requirements.txt
在project -> documentation -> documentation
文件夹中,我添加了README.md
与上述 Docsify 示例相同的级别,该示例在本地提供的服务非常好。
通过index.html
烧瓶加载(仔细查看,您会看到侧边栏和汉堡菜单按钮),但降价内容没有,我收到“404 - 未找到”消息。
我根本不知道如何实现这一点,更不用说如何优雅地做到这一点了。