Giter Club home page Giter Club logo

doc's Introduction

工具介绍

这是一个基于 Ant Design VueMarked.jsHighlight.js 开发的文档模块,用于快速构建文档。


工具特点

  • 纯静态,不依赖数据库,开箱即用
  • Markdown 语法解析 + 支持代码高亮
  • 自动根据标题生成多级锚点链接,支持快速跳转

如何使用

将 Markdown 文档放入 doc 目录,如:

doc/doc1.md
doc/doc2.md
doc/doc3.md
doc/doc4.md
doc/doc5.md
doc/doc6.md

config.json 中配置标题及菜单,如:

{
    "title": "文档模块", // 标题名称
    "menu": [
        {
            "title": "父级菜单 1", // 父级菜单名称
            "icon": "folder", // 父级菜单图标(图标地址:https://antdv.com/components/icon-cn/)
            "child": [
                {
                    "title": "子级菜单 1", // 子级菜单名称
                    "key": "doc1" // 子级菜单文档名称(doc/doc1.md)
                },
                {
                    "title": "子级菜单 2",
                    "key": "doc2"
                }
            ]
        },
        {
            "title": "父级菜单 2",
            "icon": "heart",
            "child": [
                {
                    "title": "子级菜单 3",
                    "key": "doc3"
                },
                {
                    "title": "子级菜单 4",
                    "key": "doc4"
                }
            ]
        },
        {
            "title": "父级菜单 3",
            "icon": "bulb",
            "child": [
                {
                    "title": "子级菜单 5",
                    "key": "doc5"
                },
                {
                    "title": "子级菜单 6",
                    "key": "doc6"
                }
            ]
        }
    ]
}

doc's People

Contributors

yoonper avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

doc's Issues

建议优化

代码很精简,简单高效,点个赞;如果下面三个点能够优化,那就很牛逼了:

  • 左侧导航目录,每个子页面没有对应的url, 可以根据key生成独立的url,这样方便分享
  • 右侧导航目录层级现在只有一级,可以参考语雀进行多级目录优化
  • markdown主题可以选择比较好的主题,譬如参考 马克飞象

这是我们官方帮助手册,已经用上了,https://scriptiot.github.io/evm_doc/

感谢!!!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.