Django引入docsify文档


docsify 介绍

docsify:一个神奇的文档站点生成器。

官网:https://docsify.js.org/

我们在开发项目时,需要一份精致的开发文档,那么使用 docsify 是个不错的选择,docsify 是一个快速生成 Vue 风格文档的工具,它直接加载 Markdown 文件并动态渲染,同时还可以生成封面页。我们只需要写完 Markdown 文档,就可以看到类似下方图片的文档页面了。

基础的配置和搭建我这里就不说了,官网有详细的步骤

docsify 嵌入Django项目

1.根据官网教程生成 docs 文件夹

2.将 docs 文件夹(除去index.html)放入 Django 项目的 static 文件夹中(下图我已经做了一些文档配置,所以多了一些文件)

3.将 docs 中的 index.html 放入 templates 文件夹中,我这里将 index.html 改为了 docs.html

4.在 docs.html 中设置静态文件路径

<script>
    window.$docsify = {
    basePath:'/static/docs/',
    ...
    ...
    }
</script>

5.在view.py增加一个视图,返回文档首页 docs.html

def docs(request):
    return render(request, 'docs.html')

6.在urls.py中增加一个路由

path('docs', views.docs, name='docs'),

7.运行 Django 项目,访问 127.0.0.1:8000/docs 就可以成功看到文档页了


文章作者: 简简
版权声明: 本博客所有文章除特別声明外,均采用 CC BY 4.0 许可协议。转载请注明来源 简简 !
评论-----昵称和邮箱必填,网址选填
 上一篇
多功能Web安全工具--毕设 多功能Web安全工具--毕设
本项目是我的毕业设计,一款基于Python-Django的多功能Web安全渗透测试工具,包含漏洞扫描,端口扫描,指纹识别,目录扫描,旁站扫描,域名扫描等功能。
2021-02-10
下一篇 
保研电子科大经验分享 保研电子科大经验分享
努力不一定有收获,不努力就一定没有收获,机会永远把握在自己手里,越努力越幸运!遇事不要急躁,慢慢来,比较快!
2020-10-13
  目录